These are the messages that will be spoken to the user as the tool is running.
For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.
ToolMessageStart
ToolMessageComplete
ToolMessageFailed
ToolMessageDelayed
Show child attributes
method
enum<string>
Available options:
POST,
GET
timeoutSeconds
number
This is the timeout in seconds for the request. Defaults to 20 seconds.
@default 20
Required range: 1 <= x <= 300
Example:
20
function
object
This is the function definition of the tool.
For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases.
An example of an advanced use case is if you want to customize the message that's spoken for endCall tool. You can specify a function where it returns an argument "reason". Then, in messages array, you can have many "request-complete" messages. One of these messages will be triggered if the messages[].conditions matches the "reason" argument.
Show child attributes
name
string
This is the name of the tool. This will be passed to the model.
Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.
Maximum string length: 40
Pattern: /^[a-zA-Z0-9_-]{1,40}$/
description
string
This is the description of the tool. This will be passed to the model.
Maximum string length: 1000
url
string
This is where the request will be sent.
body
object
This is the body of the request.
Show child attributes
headers
object
These are the headers to send in the request.
Show child attributes
backoffPlan
object
This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).
@default undefined (the request will not be retried)
Show child attributes
variableExtractionPlan
object
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.
Usage:
Use aliases to extract variables from the tool's response body. (Most common case)
$ 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).
Use aliases to extract variables from the tool's response headers.
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).
Use schema to extract a large portion of the tool's response body.
4.1. If you hit example.com and it returns {"name": "John", "age": 30}, then you can specify the schema as:
This will be extracted as {{ zipCodes }}. To access the array items, you can use {{ zipCodes[0] }} and {{ zipCodes[1] }}.
4.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:
This 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] }}.
Note: Both aliases and schema can be used together.
Show child attributes
Response
200 - application/json
ApiRequestTool
DtmfTool
EndCallTool
FunctionTool
GhlTool
MakeTool
TransferCallTool
OutputTool
BashTool
ComputerTool
TextEditorTool
QueryTool
GoogleCalendarCreateEventTool
GoogleSheetsRowAppendTool
GoogleCalendarCheckAvailabilityTool
SlackSendMessageTool
SmsSendTool
McpTool
GoHighLevelCalendarAvailabilityTool
GoHighLevelCalendarEventCreateTool
GoHighLevelContactCreateTool
GoHighLevelContactGetTool
type
enum<string>
required
The type of tool. "apiRequest" for API request tool.
Available options:
apiRequest
method
enum<string>
required
Available options:
POST,
GET
id
string
required
This is the unique identifier for the tool.
orgId
string
required
This is the unique identifier for the organization that this tool belongs to.
createdAt
string<date-time>
required
This is the ISO 8601 date-time string of when the tool was created.
updatedAt
string<date-time>
required
This is the ISO 8601 date-time string of when the tool was last updated.
These are the messages that will be spoken to the user as the tool is running.
For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.
ToolMessageStart
ToolMessageComplete
ToolMessageFailed
ToolMessageDelayed
Show child attributes
timeoutSeconds
number
This is the timeout in seconds for the request. Defaults to 20 seconds.
@default 20
Required range: 1 <= x <= 300
Example:
20
function
object
This is the function definition of the tool.
For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases.
An example of an advanced use case is if you want to customize the message that's spoken for endCall tool. You can specify a function where it returns an argument "reason". Then, in messages array, you can have many "request-complete" messages. One of these messages will be triggered if the messages[].conditions matches the "reason" argument.
Show child attributes
name
string
This is the name of the tool. This will be passed to the model.
Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.
Maximum string length: 40
Pattern: /^[a-zA-Z0-9_-]{1,40}$/
description
string
This is the description of the tool. This will be passed to the model.
Maximum string length: 1000
body
object
This is the body of the request.
Show child attributes
headers
object
These are the headers to send in the request.
Show child attributes
backoffPlan
object
This is the backoff plan if the request fails. Defaults to undefined (the request will not be retried).
@default undefined (the request will not be retried)
Show child attributes
variableExtractionPlan
object
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.
Usage:
Use aliases to extract variables from the tool's response body. (Most common case)
$ 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).
Use aliases to extract variables from the tool's response headers.
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).
Use schema to extract a large portion of the tool's response body.
4.1. If you hit example.com and it returns {"name": "John", "age": 30}, then you can specify the schema as:
This will be extracted as {{ zipCodes }}. To access the array items, you can use {{ zipCodes[0] }} and {{ zipCodes[1] }}.
4.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:
This 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] }}.
Note: Both aliases and schema can be used together.
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/tools/update-tool","slug":"/api-reference/tools/update-tool","pageMetadata":{"openapi":"patch /tool/{id}","title":"Update Tool","description":null,"href":"/api-reference/tools/update-tool"},"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 /tool/{id}","title":"Update Tool","description":null,"href":"/api-reference/tools/update-tool"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"ToolController_update","summary":"Update Tool","parameters":["8612b823-1c1c-4865-b84e-99a40d2103dd"],"requestBody":"3b1dc3ee-01c5-48d7-903c-7f289d7d40de","responses":{"200":"a6c163ab-b871-448c-a0b3-83c4013a167e"},"tags":["Tools"],"security":["427368f3-06de-426a-abe2-75fda5295409"],"method":"patch","type":"path","servers":["b5b8326a-680d-4e65-bd4d-46e31c9c1334","1698761f-fe56-43c1-839e-05ab7d829049"],"path":"/tool/{id}","baseUrlOptions":["https://api.cozmox.ai","https://api.cozmox.ai"],"title":"Update Tool","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8612b823-1c1c-4865-b84e-99a40d2103dd":{"name":"id","required":true,"in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ApiRequestTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.0.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"method":{"type":"string","enum":["POST","GET"],"uniqueKey":"oneOf.0.method","typeLabel":"enum\u003cstring>"},"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":"oneOf.0.timeoutSeconds","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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.0.function","typeLabel":"object"},"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":"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":"oneOf.0.description","typeLabel":"string"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.0.url","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":"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":"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":"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":"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":"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":"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":"oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"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":"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":"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":"oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"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":"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":"oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.variableExtractionPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"DtmfTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.1.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.1.function","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.2.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.2.function","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.3.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":"oneOf.3.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":"oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"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":"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":"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":"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":"oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.3.function","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"FunctionTool · object"},{"type":"object","title":"GhlTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.4.function","typeLabel":"object"},"metadata":{"type":"object","properties":{"workflowId":{"type":"string","uniqueKey":"oneOf.4.metadata.workflowId","typeLabel":"string"},"locationId":{"type":"string","uniqueKey":"oneOf.4.metadata.locationId","typeLabel":"string"}},"uniqueKey":"oneOf.4.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.4","typeLabel":"GhlTool · object"},{"type":"object","title":"MakeTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.5.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.5.function","typeLabel":"object"},"metadata":{"type":"object","properties":{"scenarioId":{"type":"number","uniqueKey":"oneOf.5.metadata.scenarioId","typeLabel":"number"},"triggerHookId":{"type":"number","uniqueKey":"oneOf.5.metadata.triggerHookId","typeLabel":"number"}},"uniqueKey":"oneOf.5.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.5","typeLabel":"MakeTool · object"},{"type":"object","title":"TransferCallTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"oneOf.6.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"oneOf.6.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.6.function","typeLabel":"object"}},"uniqueKey":"oneOf.6","typeLabel":"TransferCallTool · object"},{"type":"object","title":"OutputTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.7.function","typeLabel":"object"}},"uniqueKey":"oneOf.7","typeLabel":"OutputTool · object"},{"type":"object","title":"BashTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.8.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","uniqueKey":"oneOf.8.subType","typeLabel":"enum\u003cstring>"},"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":"oneOf.8.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.8.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":"oneOf.8.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":"oneOf.8.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":"oneOf.8.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":"oneOf.8.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.8.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.8.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.8.function","typeLabel":"object"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"uniqueKey":"oneOf.8.name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.9.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","uniqueKey":"oneOf.9.subType","typeLabel":"enum\u003cstring>"},"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":"oneOf.9.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.9.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":"oneOf.9.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":"oneOf.9.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":"oneOf.9.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":"oneOf.9.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.9.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.9.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.9.function","typeLabel":"object"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"uniqueKey":"oneOf.9.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","uniqueKey":"oneOf.9.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","uniqueKey":"oneOf.9.displayHeightPx","typeLabel":"number"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"oneOf.9.displayNumber","typeLabel":"number"}},"uniqueKey":"oneOf.9","typeLabel":"ComputerTool · object"},{"type":"object","title":"TextEditorTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.10.messages","typeLabel":"(ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object)[]"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","uniqueKey":"oneOf.10.subType","typeLabel":"enum\u003cstring>"},"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":"oneOf.10.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.10.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":"oneOf.10.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":"oneOf.10.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":"oneOf.10.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":"oneOf.10.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.10.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.10.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.10.function","typeLabel":"object"},"name":{"type":"string","description":"The name of the tool, fixed to 'str_replace_editor'","default":"str_replace_editor","enum":["str_replace_editor"],"uniqueKey":"oneOf.10.name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10","typeLabel":"TextEditorTool · object"},{"type":"object","title":"QueryTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.11.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":"oneOf.11.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.11.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":"oneOf.11.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.11.function","typeLabel":"object"}},"uniqueKey":"oneOf.11","typeLabel":"QueryTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.12.function","typeLabel":"object"}},"uniqueKey":"oneOf.12","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.13.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.13.function","typeLabel":"object"}},"uniqueKey":"oneOf.13","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.14.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.14.function","typeLabel":"object"}},"uniqueKey":"oneOf.14","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"SlackSendMessageTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.15.function","typeLabel":"object"}},"uniqueKey":"oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsSendTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.16.function","typeLabel":"object"}},"uniqueKey":"oneOf.16","typeLabel":"SmsSendTool · object"},{"type":"object","title":"McpTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"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":"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":"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":"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":"oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.17.function","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":"oneOf.17.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.17","typeLabel":"McpTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.18.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.18.function","typeLabel":"object"}},"uniqueKey":"oneOf.18","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.19.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.19.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":"oneOf.19.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.19.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.19.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.19.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.19.function","typeLabel":"object"}},"uniqueKey":"oneOf.19","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.20.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.20.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":"oneOf.20.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.20.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.20.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.20.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.20.function","typeLabel":"object"}},"uniqueKey":"oneOf.20","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","properties":{"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.21.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.21.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":"oneOf.21.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.21.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.21.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.21.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.21.function","typeLabel":"object"}},"uniqueKey":"oneOf.21","typeLabel":"GoHighLevelContactGetTool · object"}],"uniqueKey":"","typeLabel":"ApiRequestTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GhlTool · object | MakeTool · object | TransferCallTool · object | OutputTool · object | BashTool · object | ComputerTool · object | TextEditorTool · object | QueryTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | GoogleCalendarCheckAvailabilityTool · object | SlackSendMessageTool · object | SmsSendTool · object | McpTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object"},"examples":{"Example":{"title":"Example","value":{"messages":[{"type":"request-start","contents":[{"type":"text","text":"\u003cstring>"}],"blocking":false,"content":"\u003cstring>","conditions":[{"param":"\u003cstring>","value":"\u003cstring>"}]}],"timeoutSeconds":20,"name":"\u003cstring>","description":"\u003cstring>","url":"\u003cstring>","variableExtractionPlan":{"aliases":[{"key":"\u003cstring>","value":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a6c163ab-b871-448c-a0b3-83c4013a167e":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"ApiRequestTool","required":["type","method","id","orgId","createdAt","updatedAt","url"],"properties":{"type":{"type":"string","enum":["apiRequest"],"description":"The type of tool. \"apiRequest\" for API request tool.","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"method":{"type":"string","enum":["POST","GET"],"isRequired":true,"uniqueKey":"oneOf.0.method","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.0.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","description":"This is where the request will be sent.","isRequired":true,"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.0.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"oneOf.0.timeoutSeconds","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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.0.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.0.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.0.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.0.function","typeLabel":"object"},"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.body.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.body.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.body.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.body.title","typeLabel":"string"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.headers.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.headers.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.headers.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.headers.title","typeLabel":"string"}},"uniqueKey":"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":"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":"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":"oneOf.0.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"oneOf.0.variableExtractionPlan.schema.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.0.variableExtractionPlan.schema.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.variableExtractionPlan.schema.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.0.variableExtractionPlan.schema.title","typeLabel":"string"}},"uniqueKey":"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":"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":"oneOf.0.variableExtractionPlan.aliases.items.[INDEX].value","typeLabel":"string"}},"required":["key","value"],"uniqueKey":"oneOf.0.variableExtractionPlan.aliases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.variableExtractionPlan.aliases","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.variableExtractionPlan","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"ApiRequestTool · object"},{"type":"object","title":"DtmfTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["dtmf"],"description":"The type of tool. \"dtmf\" for DTMF tool.","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.1.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.1.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.1.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.1.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.1.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.1.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.1.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.1.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.1.function","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"DtmfTool · object"},{"type":"object","title":"EndCallTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["endCall"],"description":"The type of tool. \"endCall\" for End Call tool.","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.2.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.2.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.2.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.2.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.2.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.2.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.2.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.2.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.2.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.2.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.2.function","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"EndCallTool · object"},{"type":"object","title":"FunctionTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. \"function\" for Function tool.","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.3.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.3.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.3.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.3.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.3.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.3.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":"oneOf.3.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":"oneOf.3.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"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":"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":"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":"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":"oneOf.3.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.3.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.3.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.3.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.3.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.3.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.3.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.3.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.3.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.3.function","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"FunctionTool · object"},{"type":"object","title":"GhlTool","required":["type","id","orgId","createdAt","updatedAt","metadata"],"properties":{"type":{"type":"string","enum":["ghl"],"description":"The type of tool. \"ghl\" for GHL tool.","isRequired":true,"uniqueKey":"oneOf.4.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.4.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.4.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.4.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.4.updatedAt","typeLabel":"string\u003cdate-time>"},"metadata":{"type":"object","properties":{"workflowId":{"type":"string","uniqueKey":"oneOf.4.metadata.workflowId","typeLabel":"string"},"locationId":{"type":"string","uniqueKey":"oneOf.4.metadata.locationId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.4.metadata","typeLabel":"object"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.4.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.4.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.4.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.4.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.4.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.4.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.4.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.4.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.4.function","typeLabel":"object"}},"uniqueKey":"oneOf.4","typeLabel":"GhlTool · object"},{"type":"object","title":"MakeTool","required":["type","id","orgId","createdAt","updatedAt","metadata"],"properties":{"type":{"type":"string","enum":["make"],"description":"The type of tool. \"make\" for Make tool.","isRequired":true,"uniqueKey":"oneOf.5.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.5.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.5.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.5.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.5.updatedAt","typeLabel":"string\u003cdate-time>"},"metadata":{"type":"object","properties":{"scenarioId":{"type":"number","uniqueKey":"oneOf.5.metadata.scenarioId","typeLabel":"number"},"triggerHookId":{"type":"number","uniqueKey":"oneOf.5.metadata.triggerHookId","typeLabel":"number"}},"isRequired":true,"uniqueKey":"oneOf.5.metadata","typeLabel":"object"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.5.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.5.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.5.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.5.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.5.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.5.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.5.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.5.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.5.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.5.function","typeLabel":"object"}},"uniqueKey":"oneOf.5","typeLabel":"MakeTool · object"},{"type":"object","title":"TransferCallTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["transferCall"],"isRequired":true,"uniqueKey":"oneOf.6.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.6.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.6.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.6.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.6.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.6.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.6.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.0.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.0","typeLabel":"Assistant · object"},{"type":"object","title":"Number","required":["type","number"],"properties":{"type":{"type":"string","enum":["number"],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.1","typeLabel":"Number · object"},{"type":"object","title":"Sip","required":["type","sipUri"],"properties":{"type":{"type":"string","enum":["sip"],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1.content","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.message.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.summaryPlan.timeoutSeconds","typeLabel":"number"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"oneOf.6.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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.contents","typeLabel":"Text · object[]"},"content":{"type":"string","description":"This is the content that the assistant will say when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1.content","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.message.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan.endCallEnabled","typeLabel":"boolean"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2.transferPlan.fallbackPlan","typeLabel":"object"}},"uniqueKey":"oneOf.6.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":"oneOf.6.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":"oneOf.6.destinations.items.[INDEX].oneOf.2.description","typeLabel":"string"}},"uniqueKey":"oneOf.6.destinations.items.[INDEX].oneOf.2","typeLabel":"Sip · object"}],"uniqueKey":"oneOf.6.destinations.items.[INDEX]","typeLabel":"Assistant · object | Number · object | Sip · object"},"uniqueKey":"oneOf.6.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.6.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.6.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.6.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.6.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.6.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.6.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.6.function","typeLabel":"object"}},"uniqueKey":"oneOf.6","typeLabel":"TransferCallTool · object"},{"type":"object","title":"OutputTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["output"],"description":"The type of tool. \"output\" for Output tool.","isRequired":true,"uniqueKey":"oneOf.7.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.7.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.7.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.7.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.7.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.7.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.7.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.7.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.7.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.7.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.7.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.7.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.7.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.7.function","typeLabel":"object"}},"uniqueKey":"oneOf.7","typeLabel":"OutputTool · object"},{"type":"object","title":"BashTool","required":["type","subType","id","orgId","createdAt","updatedAt","name"],"properties":{"type":{"type":"string","enum":["bash"],"description":"The type of tool. \"bash\" for Bash tool.","isRequired":true,"uniqueKey":"oneOf.8.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["bash_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"oneOf.8.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.8.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.8.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.8.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.8.updatedAt","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of the tool, fixed to 'bash'","default":"bash","enum":["bash"],"isRequired":true,"uniqueKey":"oneOf.8.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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.8.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.8.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.8.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":"oneOf.8.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.8.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":"oneOf.8.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":"oneOf.8.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":"oneOf.8.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":"oneOf.8.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.8.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.8.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.8.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.8.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.8.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.8.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.8.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.8.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.8.function","typeLabel":"object"}},"uniqueKey":"oneOf.8","typeLabel":"BashTool · object"},{"type":"object","title":"ComputerTool","required":["type","subType","id","orgId","createdAt","updatedAt","name","displayWidthPx","displayHeightPx"],"properties":{"type":{"type":"string","enum":["computer"],"description":"The type of tool. \"computer\" for Computer tool.","isRequired":true,"uniqueKey":"oneOf.9.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["computer_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"oneOf.9.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.9.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.9.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.9.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.9.updatedAt","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","description":"The name of the tool, fixed to 'computer'","default":"computer","enum":["computer"],"isRequired":true,"uniqueKey":"oneOf.9.name","typeLabel":"enum\u003cstring>"},"displayWidthPx":{"type":"number","description":"The display width in pixels","isRequired":true,"uniqueKey":"oneOf.9.displayWidthPx","typeLabel":"number"},"displayHeightPx":{"type":"number","description":"The display height in pixels","isRequired":true,"uniqueKey":"oneOf.9.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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.9.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.9.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.9.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":"oneOf.9.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.9.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":"oneOf.9.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":"oneOf.9.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":"oneOf.9.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":"oneOf.9.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.9.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.9.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.9.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.9.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.9.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.9.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.9.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.9.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.9.function","typeLabel":"object"},"displayNumber":{"type":"number","description":"Optional display number","uniqueKey":"oneOf.9.displayNumber","typeLabel":"number"}},"uniqueKey":"oneOf.9","typeLabel":"ComputerTool · object"},{"type":"object","title":"TextEditorTool","required":["type","subType","id","orgId","createdAt","updatedAt","name"],"properties":{"type":{"type":"string","enum":["textEditor"],"description":"The type of tool. \"textEditor\" for Text Editor tool.","isRequired":true,"uniqueKey":"oneOf.10.type","typeLabel":"enum\u003cstring>"},"subType":{"type":"string","enum":["text_editor_20241022"],"description":"The sub type of tool.","isRequired":true,"uniqueKey":"oneOf.10.subType","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.10.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.10.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.10.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.10.updatedAt","typeLabel":"string\u003cdate-time>"},"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":"oneOf.10.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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.10.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.10.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.10.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":"oneOf.10.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"oneOf.10.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":"oneOf.10.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":"oneOf.10.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":"oneOf.10.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":"oneOf.10.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.10.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"oneOf.10.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.10.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.10.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.10.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.10.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.10.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.10.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.10.function","typeLabel":"object"}},"uniqueKey":"oneOf.10","typeLabel":"TextEditorTool · object"},{"type":"object","title":"QueryTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["query"],"description":"The type of tool. \"query\" for Query tool.","isRequired":true,"uniqueKey":"oneOf.11.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.11.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.11.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.11.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.11.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.11.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.11.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.11.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":"oneOf.11.knowledgeBases.items.[INDEX].name","typeLabel":"string"},"provider":{"type":"string","description":"The provider of the knowledge base","enum":["google"],"example":"google","isRequired":true,"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"description":{"type":"string","description":"A description of the knowledge base","isRequired":true,"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].description","typeLabel":"string"},"fileIds":{"description":"The file IDs associated with this knowledge base","type":"array","items":{"type":"string","uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX].fileIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.11.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":"oneOf.11.knowledgeBases.items.[INDEX].model","typeLabel":"enum\u003cstring>"}},"required":["name","provider","description","fileIds"],"uniqueKey":"oneOf.11.knowledgeBases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.11.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.11.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.11.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.11.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.11.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.11.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.11.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.11.function","typeLabel":"object"}},"uniqueKey":"oneOf.11","typeLabel":"QueryTool · object"},{"type":"object","title":"GoogleCalendarCreateEventTool","required":["type","id","orgId","createdAt","updatedAt"],"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":"oneOf.12.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.12.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.12.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.12.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.12.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.12.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.12.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.12.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.12.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.12.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.12.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.12.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.12.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.12.function","typeLabel":"object"}},"uniqueKey":"oneOf.12","typeLabel":"GoogleCalendarCreateEventTool · object"},{"type":"object","title":"GoogleSheetsRowAppendTool","required":["type","id","orgId","createdAt","updatedAt"],"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":"oneOf.13.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.13.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.13.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.13.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.13.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.13.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.13.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.13.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.13.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.13.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.13.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.13.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.13.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.13.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.13.function","typeLabel":"object"}},"uniqueKey":"oneOf.13","typeLabel":"GoogleSheetsRowAppendTool · object"},{"type":"object","title":"GoogleCalendarCheckAvailabilityTool","required":["type","id","orgId","createdAt","updatedAt"],"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":"oneOf.14.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.14.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.14.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.14.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.14.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.14.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.14.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.14.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.14.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.14.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.14.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.14.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.14.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.14.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.14.function","typeLabel":"object"}},"uniqueKey":"oneOf.14","typeLabel":"GoogleCalendarCheckAvailabilityTool · object"},{"type":"object","title":"SlackSendMessageTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["slack.message.send"],"description":"The type of tool. \"slack.message.send\" for Slack send message tool.","isRequired":true,"uniqueKey":"oneOf.15.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.15.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.15.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.15.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.15.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.15.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.15.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.15.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.15.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.15.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.15.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.15.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.15.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.15.function","typeLabel":"object"}},"uniqueKey":"oneOf.15","typeLabel":"SlackSendMessageTool · object"},{"type":"object","title":"SmsSendTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["sms"],"description":"The type of tool. \"sms\" for Twilio SMS sending tool.","isRequired":true,"uniqueKey":"oneOf.16.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.16.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.16.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.16.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.16.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.16.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.16.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.16.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.16.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.16.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.16.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.16.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.16.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.16.function","typeLabel":"object"}},"uniqueKey":"oneOf.16","typeLabel":"SmsSendTool · object"},{"type":"object","title":"McpTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["mcp"],"description":"The type of tool. \"mcp\" for MCP tool.","isRequired":true,"uniqueKey":"oneOf.17.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.17.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.17.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.17.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.17.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.17.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.17.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"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":"oneOf.17.server.timeoutSeconds","typeLabel":"number"},"url":{"type":"string","description":"This is where the request will be sent.","uniqueKey":"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":"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":"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":"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":"oneOf.17.server.backoffPlan.baseDelaySeconds","typeLabel":"number"}},"uniqueKey":"oneOf.17.server.backoffPlan","typeLabel":"object"}},"uniqueKey":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.17.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.17.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.17.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.17.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.17.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.17.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.17.function","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":"oneOf.17.metadata.protocol","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.17.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.17","typeLabel":"McpTool · object"},{"type":"object","title":"GoHighLevelCalendarAvailabilityTool","required":["type","id","orgId","createdAt","updatedAt"],"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":"oneOf.18.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.18.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.18.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.18.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.18.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"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":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"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":"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":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"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":"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":"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":"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":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.18.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.18.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.18.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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"oneOf.18.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"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":"oneOf.18.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.18.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"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":"oneOf.18.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.18.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.18.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.18.function","typeLabel":"object"}},"uniqueKey":"oneOf.18","typeLabel":"GoHighLevelCalendarAvailabilityTool · object"},{"type":"object","title":"GoHighLevelCalendarEventCreateTool","required":["type","id","orgId","createdAt","updatedAt"],"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":"oneOf.19.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.19.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.19.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.19.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.19.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.19.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.19.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.19.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":"oneOf.19.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.19.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.19.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.19.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.19.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.19.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.19.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.19.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.19.function","typeLabel":"object"}},"uniqueKey":"oneOf.19","typeLabel":"GoHighLevelCalendarEventCreateTool · object"},{"type":"object","title":"GoHighLevelContactCreateTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.create"],"description":"The type of tool. \"gohighlevel.contact.create\" for GoHighLevel contact create tool.","isRequired":true,"uniqueKey":"oneOf.20.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.20.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.20.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.20.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.20.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.20.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.20.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.20.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":"oneOf.20.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.20.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.20.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.20.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.20.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.20.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.20.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.20.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.20.function","typeLabel":"object"}},"uniqueKey":"oneOf.20","typeLabel":"GoHighLevelContactCreateTool · object"},{"type":"object","title":"GoHighLevelContactGetTool","required":["type","id","orgId","createdAt","updatedAt"],"properties":{"type":{"type":"string","enum":["gohighlevel.contact.get"],"description":"The type of tool. \"gohighlevel.contact.get\" for GoHighLevel contact get tool.","isRequired":true,"uniqueKey":"oneOf.21.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"This is the unique identifier for the tool.","isRequired":true,"uniqueKey":"oneOf.21.id","typeLabel":"string"},"orgId":{"type":"string","description":"This is the unique identifier for the organization that this tool belongs to.","isRequired":true,"uniqueKey":"oneOf.21.orgId","typeLabel":"string"},"createdAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was created.","isRequired":true,"uniqueKey":"oneOf.21.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"This is the ISO 8601 date-time string of when the tool was last updated.","isRequired":true,"uniqueKey":"oneOf.21.updatedAt","typeLabel":"string\u003cdate-time>"},"messages":{"type":"array","description":"These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.","items":{"oneOf":[{"type":"object","title":"ToolMessageStart","required":["type"],"properties":{"type":{"type":"string","enum":["request-start"],"description":"This message is triggered when the tool call starts.\n\nThis message is never triggered for async tools.\n\nIf this message is not provided, one of the default filler messages \"Hold on a sec\", \"One moment\", \"Just a sec\", \"Give me a moment\" or \"This'll just take a sec\" will be used.","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.contents","typeLabel":"Text · object[]"},"blocking":{"type":"boolean","description":"This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false.\n\n@default false","example":false,"default":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.blocking","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.0","typeLabel":"ToolMessageStart · object"},{"type":"object","title":"ToolMessageComplete","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is complete.\n\nThis message is triggered immediately without waiting for your server to respond for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-complete"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.contents","typeLabel":"Text · object[]"},"role":{"type":"string","description":"This is optional and defaults to \"assistant\".\n\nWhen role=assistant, `content` is said out loud.\n\nWhen role=system, `content` is passed to the model in a system message. Example:\n system: default one\n assistant:\n user:\n assistant:\n user:\n assistant:\n user:\n assistant: tool called\n tool: your server response\n \u003c--- system prompt as hint\n ---> model generates response which is spoken\nThis is useful when you want to provide a hint to the model about what to say next.","enum":["assistant","system"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\nThis is ignored if `role` is set to `system`.\n\n@default false","example":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.1","typeLabel":"ToolMessageComplete · object"},{"type":"object","title":"ToolMessageFailed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call fails.\n\nThis message is never triggered for async tool calls.\n\nIf this message is not provided, the model will be requested to respond.\n\nIf this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It's an exclusive OR.","enum":["request-failed"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.contents","typeLabel":"Text · object[]"},"endCallAfterSpokenEnabled":{"type":"boolean","description":"This is an optional boolean that if true, the call will end after the message is spoken. Default is false.\n\n@default false","example":false,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.endCallAfterSpokenEnabled","typeLabel":"boolean"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.2","typeLabel":"ToolMessageFailed · object"},{"type":"object","title":"ToolMessageDelayed","required":["type"],"properties":{"type":{"type":"string","description":"This message is triggered when the tool call is delayed.\n\nThere are the two things that can trigger this message:\n1. The user talks with the assistant while your server is processing the request. Default is \"Sorry, a few more seconds.\"\n2. The server doesn't respond within `timingMilliseconds`.\n\nThis message is never triggered for async tool calls.","enum":["request-response-delayed"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"contents":{"type":"array","description":"This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.\n\nUsage:\n- If your assistants are multilingual, you can provide content for each language.\n- If you don't provide content for a language, the first item in the array will be automatically translated to the active language at that moment.\n\nThis will override the `content` property.","items":{"type":"object","title":"Text","required":["type","text","language"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].text","typeLabel":"string"},"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"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents.items.[INDEX]","typeLabel":"Text · object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.contents","typeLabel":"Text · object[]"},"timingMilliseconds":{"type":"number","minimum":100,"maximum":120000,"example":1000,"description":"The number of milliseconds to wait for the server response before saying this message.","uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.timingMilliseconds","typeLabel":"number"},"content":{"type":"string","description":"This is the content that the assistant says when this message is triggered.","maxLength":1000,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.content","typeLabel":"string"},"conditions":{"description":"This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.","type":"array","items":{"type":"object","properties":{"operator":{"type":"string","description":"This is the operator you want to use to compare the parameter and value.","enum":["eq","neq","gt","gte","lt","lte"],"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"This is the name of the parameter that you want to check.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].param","typeLabel":"string"},"value":{"type":"string","description":"This is the value you want to compare against the parameter.","maxLength":1000,"isRequired":true,"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX].value","typeLabel":"string"}},"required":["operator","param","value"],"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3.conditions","typeLabel":"object[]"}},"uniqueKey":"oneOf.21.messages.items.[INDEX].oneOf.3","typeLabel":"ToolMessageDelayed · object"}],"uniqueKey":"oneOf.21.messages.items.[INDEX]","typeLabel":"ToolMessageStart · object | ToolMessageComplete · object | ToolMessageFailed · object | ToolMessageDelayed · object"},"uniqueKey":"oneOf.21.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":"oneOf.21.function.name","typeLabel":"string"},"strict":{"type":"boolean","description":"This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).\n\n@default false","default":false,"uniqueKey":"oneOf.21.function.strict","typeLabel":"boolean"},"description":{"type":"string","description":"This is the description of what the function does, used by the AI to choose when and how to call the function.","maxLength":1000,"uniqueKey":"oneOf.21.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.","required":["type","properties"],"properties":{"type":{"type":"string","description":"This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.","enum":["object"],"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","description":"This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.","additionalProperties":{"type":"object","properties":{"type":{"type":"string","description":"This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.","enum":["string","number","integer","boolean","array","object"],"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.type","typeLabel":"enum\u003cstring>"},"items":{"type":"object","description":"This is required if the type is \"array\". This is the schema of the items in the array.\n\nThis is of type JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.\\items","typeLabel":"object"},"properties":{"type":"object","description":"This is required if the type is \"object\". This specifies the properties of the object.\n\nThis is a map of string to JsonSchema. However, Swagger doesn't support circular references.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.properties","typeLabel":"object"},"description":{"type":"string","description":"This is the description to help the model understand what it needs to output.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.description","typeLabel":"string"},"pattern":{"type":"string","description":"This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.pattern","typeLabel":"string"},"format":{"type":"string","description":"This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat\u0026type-restrictions=string-restrictions","enum":["date-time","time","date","duration","email","hostname","ipv4","ipv6","uuid"],"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.format","typeLabel":"enum\u003cstring>"},"required":{"description":"This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.required","typeLabel":"string[]"},"enum":{"description":"This array specifies the allowed values that can be used to restrict the output of the model.","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.enum","typeLabel":"string[]"},"title":{"type":"string","description":"This is the title of the schema.","uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties.title","typeLabel":"string"}},"required":["type"],"uniqueKey":"oneOf.21.function.parameters.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.21.function.parameters.properties","typeLabel":"object"},"required":{"description":"This specifies the properties that are required by the function.","type":"array","items":{"type":"string","uniqueKey":"oneOf.21.function.parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.21.function.parameters.required","typeLabel":"string[]"}},"uniqueKey":"oneOf.21.function.parameters","typeLabel":"object"}},"uniqueKey":"oneOf.21.function","typeLabel":"object"}},"uniqueKey":"oneOf.21","typeLabel":"GoHighLevelContactGetTool · object"}],"uniqueKey":"","typeLabel":"ApiRequestTool · object | DtmfTool · object | EndCallTool · object | FunctionTool · object | GhlTool · object | MakeTool · object | TransferCallTool · object | OutputTool · object | BashTool · object | ComputerTool · object | TextEditorTool · object | QueryTool · object | GoogleCalendarCreateEventTool · object | GoogleSheetsRowAppendTool · object | GoogleCalendarCheckAvailabilityTool · object | SlackSendMessageTool · object | SmsSendTool · object | McpTool · object | GoHighLevelCalendarAvailabilityTool · object | GoHighLevelCalendarEventCreateTool · object | GoHighLevelContactCreateTool · object | GoHighLevelContactGetTool · object"},"examples":{"Example":{"title":"Example","value":{"type":"apiRequest","method":"POST","id":"\u003cstring>","orgId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","url":"\u003cstring>","messages":[{"type":"request-start","contents":[{"type":"text","text":"\u003cstring>","language":"aa"}],"blocking":false,"content":"\u003cstring>","conditions":[{"operator":"eq","param":"\u003cstring>","value":"\u003cstring>"}]}],"timeoutSeconds":20,"function":{"name":"\u003cstring>","strict":false,"description":"\u003cstring>","parameters":{"type":"object","properties":{},"required":["\u003cstring>"]}},"name":"\u003cstring>","description":"\u003cstring>","body":{"type":"string","items":{},"properties":{},"description":"\u003cstring>","pattern":"\u003cstring>","format":"date-time","required":["\u003cstring>"],"enum":["\u003cstring>"],"title":"\u003cstring>"},"headers":{"type":"string","items":{},"properties":{},"description":"\u003cstring>","pattern":"\u003cstring>","format":"date-time","required":["\u003cstring>"],"enum":["\u003cstring>"],"title":"\u003cstring>"},"backoffPlan":{"type":"fixed","maxRetries":0,"baseDelaySeconds":1},"variableExtractionPlan":{"schema":{"type":"string","items":{},"properties":{},"description":"\u003cstring>","pattern":"\u003cstring>","format":"date-time","required":["\u003cstring>"],"enum":["\u003cstring>"],"title":"\u003cstring>"},"aliases":[{"key":"\u003cstring>","value":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"427368f3-06de-426a-abe2-75fda5295409":{"bearer":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","scopes":[]}}},"servers":{"b5b8326a-680d-4e65-bd4d-46e31c9c1334":{"description":"Cozmox APIs","url":"https://api.cozmox.ai"},"1698761f-fe56-43c1-839e-05ab7d829049":{"url":"https://api.cozmox.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"Bearer","type":"http","description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Retrieve your API Key from [Dashboard](dashboard.cozmox.ai).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"czmx","siteName":"Cozmox-AI Nebula SDK","title":"Update Tool - Cozmox-AI Nebula SDK","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/tools/update-tool.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Tool - Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cozmox.cloud/api-reference/tools/update-tool\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://czmx.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Update+Tool\u0026amp;theme=95ed1721ed9e0ffde4c2ee1b\u0026amp;signature=f813cc41eacaac06db22f3010b532efabc9ea1a70941c5141bf025f77caf556b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Tool - Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://czmx.mintlify.site/_mintlify/api/og/v2?division=Tools\u0026amp;title=Update+Tool\u0026amp;theme=95ed1721ed9e0ffde4c2ee1b\u0026amp;signature=f813cc41eacaac06db22f3010b532efabc9ea1a70941c5141bf025f77caf556b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cozmox-AI Nebula SDK\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5911\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cozmox.cloud/api-reference/tools/update-tool\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tools/update-tool.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cozmox.cloud/#organization\",\"name\":\"Cozmox-AI Nebula SDK\",\"url\":\"https://docs.cozmox.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3.us-west-1.amazonaws.com/czmx/logo/logo_light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cozmox.cloud#website\",\"name\":\"Cozmox-AI Nebula SDK\",\"url\":\"https://docs.cozmox.cloud\",\"publisher\":{\"@id\":\"https://docs.cozmox.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool#webpage\",\"url\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool\",\"name\":\"Update Tool\",\"isPartOf\":{\"@id\":\"https://docs.cozmox.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://docs.cozmox.cloud/api-reference/tools/create-tool\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Tool\",\"item\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool#apireference\",\"headline\":\"Update Tool\",\"name\":\"Update Tool\",\"url\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cozmox.cloud/api-reference/tools/update-tool#webpage\"},\"publisher\":{\"@id\":\"https://docs.cozmox.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cozmox.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cozmox-AI Nebula SDK\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cozmox-AI Nebula SDK\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tools/update-tool.md","siteName":"Cozmox-AI Nebula SDK","nav":{"global":null,"tabs":[{"tab":"Documentation","anchors":[{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/webhooks"}]},{"group":"Voice Agent UI","pages":[{"title":"Introduction","href":"/api-reference/embedded"}]},{"group":"STT Usage","pages":[{"title":"Socket STT","href":"/api-reference/socket"}]},{"group":"Endpoint Examples","pages":[{"title":"Delete file","href":"/api-reference/endpoint/delete-file"},{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"}]},{"group":"Assistants","pages":[{"openapi":"post /assistant","title":"Create Assistant","href":"/api-reference/assistants/create-assistant"},{"openapi":"delete /assistant/{id}","title":"Delete Assistant","href":"/api-reference/assistants/delete-assistant"},{"openapi":"get /assistant/{id}","title":"Get Assistant","href":"/api-reference/assistants/get-assistant"},{"openapi":"get /assistant","title":"List Assistants","href":"/api-reference/assistants/list-assistants"},{"openapi":"patch /assistant/{id}","title":"Update Assistant","href":"/api-reference/assistants/update-assistant"}]},{"group":"Calls","pages":[{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"},{"openapi":"delete /call/{id}","title":"Delete Call Data","href":"/api-reference/calls/delete-call-data"},{"openapi":"get /call/{id}","title":"Get Call","href":"/api-reference/calls/get-call"},{"openapi":"get /call","title":"List Calls","href":"/api-reference/calls/list-calls"},{"openapi":"patch /call/{id}","title":"Update Call","href":"/api-reference/calls/update-call"}]},{"group":"Campaigns","pages":[{"openapi":"post /campaign","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"delete /campaign/{id}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"},{"openapi":"get /campaign/{id}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /campaign","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /campaign/{id}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"}]},{"group":"Chats","pages":[{"openapi":"post /chat/responses","title":"Create Chat (OpenAI Compatible)","href":"/api-reference/chats/create-chat-openai-compatible"},{"openapi":"post /chat","title":"Create Chat","href":"/api-reference/chats/create-chat"},{"openapi":"delete /chat/{id}","title":"Delete Chat","href":"/api-reference/chats/delete-chat"},{"openapi":"get /chat/{id}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /chat","title":"List Chats","href":"/api-reference/chats/list-chats"}]},{"group":"Files","pages":[{"openapi":"delete /file/{id}","title":"Delete File","href":"/api-reference/files/delete-file"},{"openapi":"get /file/{id}","title":"Get File","href":"/api-reference/files/get-file"},{"openapi":"get /file","title":"List Files","href":"/api-reference/files/list-files"},{"openapi":"patch /file/{id}","title":"Update File","href":"/api-reference/files/update-file"},{"openapi":"post /file","title":"Upload File","href":"/api-reference/files/upload-file"}]},{"group":"Knowledge Base","pages":[{"openapi":"post /knowledge-base","title":"Create Knowledge Base","href":"/api-reference/knowledge-base/create-knowledge-base"},{"openapi":"get /knowledge-base/{id}","title":"Get Knowledge Base","href":"/api-reference/knowledge-base/get-knowledge-base"},{"openapi":"delete /knowledge-base/{id}","title":"Delete Knowledge Base","href":"/api-reference/knowledge-base/delete-knowledge-base"},{"openapi":"get /knowledge-base","title":"List Knowledge Bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"openapi":"patch /knowledge-base/{id}","title":"Update Knowledge Base","href":"/api-reference/knowledge-base/update-knowledge-base"}]},{"group":"Logs","pages":[{"openapi":"delete /logs","deprecated":true,"title":"Delete Logs","href":"/api-reference/logs/delete-logs"},{"openapi":"get /logs","deprecated":true,"title":"Get Logs","href":"/api-reference/logs/get-logs"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /phone-number","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"delete /phone-number/{id}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"},{"openapi":"get /phone-number/{id}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /phone-number","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"}]},{"group":"Sessions","pages":[{"openapi":"post /session","title":"Create Session","href":"/api-reference/sessions/create-session"},{"openapi":"delete /session/{id}","title":"Delete Session","href":"/api-reference/sessions/delete-session"},{"openapi":"get /session/{id}","title":"Get Session","href":"/api-reference/sessions/get-session"},{"openapi":"get /session","title":"List Sessions","href":"/api-reference/sessions/list-sessions"},{"openapi":"patch /session/{id}","title":"Update Session","href":"/api-reference/sessions/update-session"}]},{"group":"Tools","pages":[{"openapi":"post /tool","title":"Create Tool","href":"/api-reference/tools/create-tool"},{"openapi":"delete /tool/{id}","title":"Delete Tool","href":"/api-reference/tools/delete-tool"},{"openapi":"get /tool/{id}","title":"Get Tool","href":"/api-reference/tools/get-tool"},{"openapi":"get /tool","title":"List Tools","description":null,"href":"/api-reference/tools/list-tools"},{"openapi":"patch /tool/{id}","title":"Update Tool","href":"/api-reference/tools/update-tool"}]},{"group":"Workflow","pages":[{"openapi":"post /workflow","title":"Create Workflow","description":null,"href":"/api-reference/workflow/create-workflow"},{"openapi":"delete /workflow/{id}","title":"Delete Workflow","href":"/api-reference/workflow/delete-workflow"},{"openapi":"get /workflow/{id}","title":"Get Workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"get /workflow","title":"Get Workflows","href":"/api-reference/workflow/get-workflows"},{"openapi":"patch /workflow/{id}","title":"Update Workflow","href":"/api-reference/workflow/update-workflow"}]},{"group":"SDK","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/nebula/hello","href":"/api-reference/sdk/hello","title":"Hello","deprecated":null,"version":null}]},{"group":"Outbound","pages":[{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/create-call","href":"/api-reference/outbound/create-a-call","title":"Create a call","deprecated":null,"version":null},{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/retrieve-call","href":"/api-reference/outbound/retrieve-a-call","title":"Retrieve a call","deprecated":null,"version":null}]},{"group":"Concurrency","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/concurrency/retrieve","href":"/api-reference/concurrency/call-concurrency","title":"Call concurrency","deprecated":null,"version":null}]}]}]},{"tab":"API Reference","anchors":[{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/webhooks"}]},{"group":"Voice Agent UI","pages":[{"title":"Introduction","href":"/api-reference/embedded"}]},{"group":"STT Usage","pages":[{"title":"Socket STT","href":"/api-reference/socket"}]},{"group":"Endpoint Examples","pages":[{"title":"Delete file","href":"/api-reference/endpoint/delete-file"},{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"}]},{"group":"Assistants","pages":[{"openapi":"post /assistant","title":"Create Assistant","href":"/api-reference/assistants/create-assistant"},{"openapi":"delete /assistant/{id}","title":"Delete Assistant","href":"/api-reference/assistants/delete-assistant"},{"openapi":"get /assistant/{id}","title":"Get Assistant","href":"/api-reference/assistants/get-assistant"},{"openapi":"get /assistant","title":"List Assistants","href":"/api-reference/assistants/list-assistants"},{"openapi":"patch /assistant/{id}","title":"Update Assistant","href":"/api-reference/assistants/update-assistant"}]},{"group":"Calls","pages":[{"openapi":"post /call","title":"Create Call","href":"/api-reference/calls/create-call"},{"openapi":"delete /call/{id}","title":"Delete Call Data","href":"/api-reference/calls/delete-call-data"},{"openapi":"get /call/{id}","title":"Get Call","href":"/api-reference/calls/get-call"},{"openapi":"get /call","title":"List Calls","href":"/api-reference/calls/list-calls"},{"openapi":"patch /call/{id}","title":"Update Call","href":"/api-reference/calls/update-call"}]},{"group":"Campaigns","pages":[{"openapi":"post /campaign","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"delete /campaign/{id}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"},{"openapi":"get /campaign/{id}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /campaign","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /campaign/{id}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"}]},{"group":"Chats","pages":[{"openapi":"post /chat/responses","title":"Create Chat (OpenAI Compatible)","href":"/api-reference/chats/create-chat-openai-compatible"},{"openapi":"post /chat","title":"Create Chat","href":"/api-reference/chats/create-chat"},{"openapi":"delete /chat/{id}","title":"Delete Chat","href":"/api-reference/chats/delete-chat"},{"openapi":"get /chat/{id}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /chat","title":"List Chats","href":"/api-reference/chats/list-chats"}]},{"group":"Files","pages":[{"openapi":"delete /file/{id}","title":"Delete File","href":"/api-reference/files/delete-file"},{"openapi":"get /file/{id}","title":"Get File","href":"/api-reference/files/get-file"},{"openapi":"get /file","title":"List Files","href":"/api-reference/files/list-files"},{"openapi":"patch /file/{id}","title":"Update File","href":"/api-reference/files/update-file"},{"openapi":"post /file","title":"Upload File","href":"/api-reference/files/upload-file"}]},{"group":"Knowledge Base","pages":[{"openapi":"post /knowledge-base","title":"Create Knowledge Base","href":"/api-reference/knowledge-base/create-knowledge-base"},{"openapi":"get /knowledge-base/{id}","title":"Get Knowledge Base","href":"/api-reference/knowledge-base/get-knowledge-base"},{"openapi":"delete /knowledge-base/{id}","title":"Delete Knowledge Base","href":"/api-reference/knowledge-base/delete-knowledge-base"},{"openapi":"get /knowledge-base","title":"List Knowledge Bases","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"openapi":"patch /knowledge-base/{id}","title":"Update Knowledge Base","href":"/api-reference/knowledge-base/update-knowledge-base"}]},{"group":"Logs","pages":[{"openapi":"delete /logs","deprecated":true,"title":"Delete Logs","href":"/api-reference/logs/delete-logs"},{"openapi":"get /logs","deprecated":true,"title":"Get Logs","href":"/api-reference/logs/get-logs"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /phone-number","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"delete /phone-number/{id}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"},{"openapi":"get /phone-number/{id}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /phone-number","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /phone-number/{id}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"}]},{"group":"Sessions","pages":[{"openapi":"post /session","title":"Create Session","href":"/api-reference/sessions/create-session"},{"openapi":"delete /session/{id}","title":"Delete Session","href":"/api-reference/sessions/delete-session"},{"openapi":"get /session/{id}","title":"Get Session","href":"/api-reference/sessions/get-session"},{"openapi":"get /session","title":"List Sessions","href":"/api-reference/sessions/list-sessions"},{"openapi":"patch /session/{id}","title":"Update Session","href":"/api-reference/sessions/update-session"}]},{"group":"Tools","pages":[{"openapi":"post /tool","title":"Create Tool","href":"/api-reference/tools/create-tool"},{"openapi":"delete /tool/{id}","title":"Delete Tool","href":"/api-reference/tools/delete-tool"},{"openapi":"get /tool/{id}","title":"Get Tool","href":"/api-reference/tools/get-tool"},{"openapi":"get /tool","title":"List Tools","description":null,"href":"/api-reference/tools/list-tools"},{"openapi":"patch /tool/{id}","title":"Update Tool","href":"/api-reference/tools/update-tool"}]},{"group":"Workflow","pages":[{"openapi":"post /workflow","title":"Create Workflow","description":null,"href":"/api-reference/workflow/create-workflow"},{"openapi":"delete /workflow/{id}","title":"Delete Workflow","href":"/api-reference/workflow/delete-workflow"},{"openapi":"get /workflow/{id}","title":"Get Workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"get /workflow","title":"Get Workflows","href":"/api-reference/workflow/get-workflows"},{"openapi":"patch /workflow/{id}","title":"Update Workflow","href":"/api-reference/workflow/update-workflow"}]},{"group":"SDK","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/nebula/hello","href":"/api-reference/sdk/hello","title":"Hello","deprecated":null,"version":null}]},{"group":"Outbound","pages":[{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/create-call","href":"/api-reference/outbound/create-a-call","title":"Create a call","deprecated":null,"version":null},{"openapi":"https://api.cozmox.cloud/api-json post /v1/outbound/retrieve-call","href":"/api-reference/outbound/retrieve-a-call","title":"Retrieve a call","deprecated":null,"version":null}]},{"group":"Concurrency","pages":[{"openapi":"https://api.cozmox.cloud/api-json get /v1/concurrency/retrieve","href":"/api-reference/concurrency/call-concurrency","title":"Call concurrency","deprecated":null,"version":null}]}]}]}]},"basePath":"","title":"Update Tool - Cozmox-AI Nebula SDK","buildId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","deploymentId":"dpl_GRSyrvXT6FFTpZZTGz5iZPp3D2zE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BFmjTMeT.js","utils-BWr-sjpP.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-LafIDf0N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-MJNzuxek.js","snippetPresets-DPZEtUvW.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DQ2UhGIs.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DUUJTUkE.js","shallow-BTf5bw35.js","getApiPlaygroundDisplay-h2POYYOO.js","CodeSnippet-C4qEftRe.js","CodeSnippets-CsSrOqMC.js","Page-CWFqNdGh.js","getPastedJson-DU6W6y78.js","icon-2ZYNQ78y.js","MethodPill-BMXJzYMm.js","DuplicateIcon-DNjdEpYZ.js","createIcon-WdPVhKxl.js","DynamicMarkdown-Z_y464fM.js","SectionHeading-Bcrd8azU.js","axios-vUo_bRtp.js","Markdown-BnvucbFu.js","dist-D7YyC486.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-D1I8TPjt.js"]}