|
10827 | 10827 | "type": "string", |
10828 | 10828 | "description": "The voices provided by Vapi", |
10829 | 10829 | "enum": [ |
10830 | | - "Jordan" |
| 10830 | + "Jordan", |
| 10831 | + "Adi", |
| 10832 | + "Julia", |
| 10833 | + "Maibri (Web)", |
| 10834 | + "Maibri (Phone)", |
| 10835 | + "Ashley" |
10831 | 10836 | ] |
10832 | 10837 | }, |
10833 | 10838 | "chunkPlan": { |
|
12337 | 12342 | "type" |
12338 | 12343 | ] |
12339 | 12344 | }, |
12340 | | - "TwilioVoicemailDetection": { |
| 12345 | + "TwilioVoicemailDetectionPlan": { |
12341 | 12346 | "type": "object", |
12342 | 12347 | "properties": { |
12343 | 12348 | "provider": { |
|
12409 | 12414 | "provider" |
12410 | 12415 | ] |
12411 | 12416 | }, |
| 12417 | + "GoogleVoicemailDetectionPlan": { |
| 12418 | + "type": "object", |
| 12419 | + "properties": { |
| 12420 | + "provider": { |
| 12421 | + "type": "string", |
| 12422 | + "description": "This is the provider to use for voicemail detection.", |
| 12423 | + "enum": [ |
| 12424 | + "google" |
| 12425 | + ] |
| 12426 | + }, |
| 12427 | + "voicemailExpectedDurationSeconds": { |
| 12428 | + "type": "number", |
| 12429 | + "description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15", |
| 12430 | + "minimum": 5, |
| 12431 | + "maximum": 60, |
| 12432 | + "default": 15 |
| 12433 | + } |
| 12434 | + }, |
| 12435 | + "required": [ |
| 12436 | + "provider", |
| 12437 | + "voicemailExpectedDurationSeconds" |
| 12438 | + ] |
| 12439 | + }, |
12412 | 12440 | "CompliancePlan": { |
12413 | 12441 | "type": "object", |
12414 | 12442 | "properties": { |
|
13027 | 13055 | "#", |
13028 | 13056 | "*", |
13029 | 13057 | "" |
13030 | | - ], |
13031 | | - "x-fern-enum": { |
13032 | | - "#": { |
13033 | | - "name": "Hash" |
13034 | | - }, |
13035 | | - "*": { |
13036 | | - "name": "Asterisk" |
13037 | | - } |
13038 | | - } |
| 13058 | + ] |
13039 | 13059 | } |
13040 | 13060 | } |
13041 | 13061 | }, |
|
13204 | 13224 | ], |
13205 | 13225 | "example": "assistant-speaks-first" |
13206 | 13226 | }, |
| 13227 | + "voicemailDetection": { |
| 13228 | + "type": "object", |
| 13229 | + "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not." |
| 13230 | + }, |
13207 | 13231 | "clientMessages": { |
13208 | 13232 | "type": "array", |
13209 | 13233 | "enum": [ |
|
13512 | 13536 | "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", |
13513 | 13537 | "maxLength": 40 |
13514 | 13538 | }, |
13515 | | - "voicemailDetection": { |
13516 | | - "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.", |
13517 | | - "allOf": [ |
13518 | | - { |
13519 | | - "$ref": "#/components/schemas/TwilioVoicemailDetection" |
13520 | | - } |
13521 | | - ] |
13522 | | - }, |
13523 | 13539 | "voicemailMessage": { |
13524 | 13540 | "type": "string", |
13525 | 13541 | "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.", |
|
13786 | 13802 | ], |
13787 | 13803 | "example": "assistant-speaks-first" |
13788 | 13804 | }, |
| 13805 | + "voicemailDetection": { |
| 13806 | + "type": "object", |
| 13807 | + "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not." |
| 13808 | + }, |
13789 | 13809 | "clientMessages": { |
13790 | 13810 | "type": "array", |
13791 | 13811 | "enum": [ |
|
14098 | 14118 | "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", |
14099 | 14119 | "maxLength": 40 |
14100 | 14120 | }, |
14101 | | - "voicemailDetection": { |
14102 | | - "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.", |
14103 | | - "allOf": [ |
14104 | | - { |
14105 | | - "$ref": "#/components/schemas/TwilioVoicemailDetection" |
14106 | | - } |
14107 | | - ] |
14108 | | - }, |
14109 | 14121 | "voicemailMessage": { |
14110 | 14122 | "type": "string", |
14111 | 14123 | "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.", |
|
14661 | 14673 | "$ref": "#/components/schemas/VapiCost", |
14662 | 14674 | "title": "VapiCost" |
14663 | 14675 | }, |
| 14676 | + { |
| 14677 | + "$ref": "#/components/schemas/VoicemailDetectionCost", |
| 14678 | + "title": "VoicemailDetectionCost" |
| 14679 | + }, |
14664 | 14680 | { |
14665 | 14681 | "$ref": "#/components/schemas/AnalysisCost", |
14666 | 14682 | "title": "AnalysisCost" |
|
15429 | 15445 | ], |
15430 | 15446 | "example": "assistant-speaks-first" |
15431 | 15447 | }, |
| 15448 | + "voicemailDetection": { |
| 15449 | + "type": "object", |
| 15450 | + "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not." |
| 15451 | + }, |
15432 | 15452 | "clientMessages": { |
15433 | 15453 | "type": "array", |
15434 | 15454 | "enum": [ |
|
15737 | 15757 | "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", |
15738 | 15758 | "maxLength": 40 |
15739 | 15759 | }, |
15740 | | - "voicemailDetection": { |
15741 | | - "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.", |
15742 | | - "allOf": [ |
15743 | | - { |
15744 | | - "$ref": "#/components/schemas/TwilioVoicemailDetection" |
15745 | | - } |
15746 | | - ] |
15747 | | - }, |
15748 | 15760 | "voicemailMessage": { |
15749 | 15761 | "type": "string", |
15750 | 15762 | "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.", |
|
16035 | 16047 | ], |
16036 | 16048 | "example": "assistant-speaks-first" |
16037 | 16049 | }, |
| 16050 | + "voicemailDetection": { |
| 16051 | + "type": "object", |
| 16052 | + "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not." |
| 16053 | + }, |
16038 | 16054 | "clientMessages": { |
16039 | 16055 | "type": "array", |
16040 | 16056 | "enum": [ |
|
16343 | 16359 | "description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.", |
16344 | 16360 | "maxLength": 40 |
16345 | 16361 | }, |
16346 | | - "voicemailDetection": { |
16347 | | - "description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.", |
16348 | | - "allOf": [ |
16349 | | - { |
16350 | | - "$ref": "#/components/schemas/TwilioVoicemailDetection" |
16351 | | - } |
16352 | | - ] |
16353 | | - }, |
16354 | 16362 | "voicemailMessage": { |
16355 | 16363 | "type": "string", |
16356 | 16364 | "description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.", |
|
20672 | 20680 | }, |
20673 | 20681 | "status": { |
20674 | 20682 | "enum": [ |
20675 | | - "indexed", |
20676 | | - "not_indexed" |
| 20683 | + "processing", |
| 20684 | + "done", |
| 20685 | + "failed" |
20677 | 20686 | ], |
20678 | 20687 | "type": "string" |
20679 | 20688 | }, |
|
20706 | 20715 | "url": { |
20707 | 20716 | "type": "string" |
20708 | 20717 | }, |
| 20718 | + "parsedTextUrl": { |
| 20719 | + "type": "string" |
| 20720 | + }, |
| 20721 | + "parsedTextBytes": { |
| 20722 | + "type": "number" |
| 20723 | + }, |
20709 | 20724 | "metadata": { |
20710 | 20725 | "type": "object" |
20711 | 20726 | }, |
|
24619 | 24634 | "threshold" |
24620 | 24635 | ] |
24621 | 24636 | }, |
| 24637 | + "InvoicePlan": { |
| 24638 | + "type": "object", |
| 24639 | + "properties": { |
| 24640 | + "companyName": { |
| 24641 | + "type": "string", |
| 24642 | + "description": "This is the name of the company." |
| 24643 | + }, |
| 24644 | + "companyAddress": { |
| 24645 | + "type": "string", |
| 24646 | + "description": "This is the address of the company." |
| 24647 | + }, |
| 24648 | + "companyTaxId": { |
| 24649 | + "type": "string", |
| 24650 | + "description": "This is the tax ID of the company." |
| 24651 | + }, |
| 24652 | + "companyEmail": { |
| 24653 | + "type": "string", |
| 24654 | + "description": "This is the preferred invoicing email of the company. If not specified, defaults to the subscription's email." |
| 24655 | + } |
| 24656 | + } |
| 24657 | + }, |
24622 | 24658 | "Subscription": { |
24623 | 24659 | "type": "object", |
24624 | 24660 | "properties": { |
|
24785 | 24821 | "couponUsageLeft": { |
24786 | 24822 | "type": "string", |
24787 | 24823 | "description": "This is the number of credits left obtained from a coupon." |
| 24824 | + }, |
| 24825 | + "invoicePlan": { |
| 24826 | + "description": "This is the invoice plan for the subscription.", |
| 24827 | + "allOf": [ |
| 24828 | + { |
| 24829 | + "$ref": "#/components/schemas/InvoicePlan" |
| 24830 | + } |
| 24831 | + ] |
24788 | 24832 | } |
24789 | 24833 | }, |
24790 | 24834 | "required": [ |
|
27292 | 27336 | "$ref": "#/components/schemas/VapiCost", |
27293 | 27337 | "title": "VapiCost" |
27294 | 27338 | }, |
| 27339 | + { |
| 27340 | + "$ref": "#/components/schemas/VoicemailDetectionCost", |
| 27341 | + "title": "VoicemailDetectionCost" |
| 27342 | + }, |
27295 | 27343 | { |
27296 | 27344 | "$ref": "#/components/schemas/AnalysisCost", |
27297 | 27345 | "title": "AnalysisCost" |
|
29721 | 29769 | "cost" |
29722 | 29770 | ] |
29723 | 29771 | }, |
| 29772 | + "VoicemailDetectionCost": { |
| 29773 | + "type": "object", |
| 29774 | + "properties": { |
| 29775 | + "type": { |
| 29776 | + "type": "string", |
| 29777 | + "description": "This is the type of cost, always 'voicemail-detection' for this class.", |
| 29778 | + "enum": [ |
| 29779 | + "voicemail-detection" |
| 29780 | + ] |
| 29781 | + }, |
| 29782 | + "model": { |
| 29783 | + "type": "object", |
| 29784 | + "description": "This is the model that was used to perform the analysis." |
| 29785 | + }, |
| 29786 | + "provider": { |
| 29787 | + "type": "string", |
| 29788 | + "description": "This is the provider that was used to detect the voicemail.", |
| 29789 | + "enum": [ |
| 29790 | + "twilio", |
| 29791 | + "google", |
| 29792 | + "openai" |
| 29793 | + ] |
| 29794 | + }, |
| 29795 | + "promptTextTokens": { |
| 29796 | + "type": "number", |
| 29797 | + "description": "This is the number of prompt text tokens used in the voicemail detection." |
| 29798 | + }, |
| 29799 | + "promptAudioTokens": { |
| 29800 | + "type": "number", |
| 29801 | + "description": "This is the number of prompt audio tokens used in the voicemail detection." |
| 29802 | + }, |
| 29803 | + "completionTextTokens": { |
| 29804 | + "type": "number", |
| 29805 | + "description": "This is the number of completion text tokens used in the voicemail detection." |
| 29806 | + }, |
| 29807 | + "completionAudioTokens": { |
| 29808 | + "type": "number", |
| 29809 | + "description": "This is the number of completion audio tokens used in the voicemail detection." |
| 29810 | + }, |
| 29811 | + "cost": { |
| 29812 | + "type": "number", |
| 29813 | + "description": "This is the cost of the component in USD." |
| 29814 | + } |
| 29815 | + }, |
| 29816 | + "required": [ |
| 29817 | + "type", |
| 29818 | + "model", |
| 29819 | + "provider", |
| 29820 | + "promptTextTokens", |
| 29821 | + "promptAudioTokens", |
| 29822 | + "completionTextTokens", |
| 29823 | + "completionAudioTokens", |
| 29824 | + "cost" |
| 29825 | + ] |
| 29826 | + }, |
29724 | 29827 | "FunctionToolWithToolCall": { |
29725 | 29828 | "type": "object", |
29726 | 29829 | "properties": { |
|
0 commit comments