From f8318a638ffad1be80ef18d57b40b15d0989fb01 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 19 Aug 2026 00:24:04 +0000 Subject: [PATCH 1/4] [fern-generated] Update SDK Generated by Fern CLI Version: unknown Generators: - fernapi/fern-typescript-sdk: 3.63.0 --- .fern/metadata.json | 6 +- .fern/replay.lock | 10 + .fernignore | 3 + .gitattributes | 1 + package.json | 79 +- pnpm-lock.yaml | 163 +- reference.md | 4903 +- src/BaseClient.ts | 4 +- src/Client.ts | 42 + src/api/errors/ConflictError.ts | 21 + src/api/errors/InternalServerError.ts | 21 + src/api/errors/PaymentRequiredError.ts | 22 + src/api/errors/ServiceUnavailableError.ts | 21 + src/api/errors/UnauthorizedError.ts | 21 + src/api/errors/index.ts | 5 + src/api/resources/analytics/client/Client.ts | 2 + src/api/resources/assistants/client/Client.ts | 29 +- .../requests/DeleteAssistantsRequest.ts | 1 + .../client/requests/GetAssistantsRequest.ts | 1 + .../client/requests/UpdateAssistantDto.ts | 4 + .../UpdateAssistantDtoCredentialsItem.ts | 74 +- .../types/UpdateAssistantDtoModel.ts | 29 +- .../UpdateAssistantDtoServerMessagesItem.ts | 1 + .../types/UpdateAssistantDtoTranscriber.ts | 12 +- .../types/UpdateAssistantDtoVoice.ts | 12 +- src/api/resources/board/client/Client.ts | 404 + src/api/resources/board/client/index.ts | 1 + .../requests/BoardControllerFindAllRequest.ts | 34 + .../requests/BoardControllerFindOneRequest.ts | 12 + .../requests/BoardControllerRemoveRequest.ts | 12 + .../board/client/requests/CreateBoardDto.ts | 27 + .../board/client/requests/UpdateBoardDto.ts | 26 + .../resources/board/client/requests/index.ts | 5 + src/api/resources/board/exports.ts | 4 + src/api/resources/board/index.ts | 2 + .../BoardControllerFindAllRequestSortBy.ts | 9 + .../BoardControllerFindAllRequestSortOrder.ts | 8 + .../board/types/CreateBoardDtoItemsItem.ts | 5 + .../board/types/UpdateBoardDtoItemsItem.ts | 5 + src/api/resources/board/types/index.ts | 4 + src/api/resources/calls/client/Client.ts | 542 +- ...rollerAssistantRecordingDownloadRequest.ts | 12 + ...tifactControllerCallLogsDownloadRequest.ts | 12 + ...trollerCustomerRecordingDownloadRequest.ts | 12 + ...tControllerMonoRecordingDownloadRequest.ts | 12 + ...llArtifactControllerPcapDownloadRequest.ts | 12 + ...ontrollerStereoRecordingDownloadRequest.ts | 12 + ...ControllerVideoRecordingDownloadRequest.ts | 12 + .../calls/client/requests/CreateCallDto.ts | 9 +- .../calls/client/requests/GetCallsRequest.ts | 1 + .../calls/client/requests/UpdateCallDto.ts | 1 + .../resources/calls/client/requests/index.ts | 7 + .../calls/types/CreateCallDtoTransport.ts | 40 + src/api/resources/calls/types/index.ts | 1 + src/api/resources/campaigns/client/Client.ts | 425 +- .../CampaignControllerFindAllRequest.ts | 4 + .../CampaignControllerFindAllV2Request.ts | 44 + .../CampaignControllerFindOneRequest.ts | 1 + .../CampaignControllerFindOneV2Request.ts | 18 + ...nControllerGetCampaignV2ContactsRequest.ts | 38 + .../CampaignControllerRemoveRequest.ts | 1 + .../CampaignControllerRemoveV2Request.ts | 12 + .../CampaignControllerUpdateRequest.ts | 16 + .../CampaignControllerUpdateV2Request.ts | 16 + .../client/requests/CreateCampaignDto.ts | 28 - .../campaigns/client/requests/index.ts | 8 +- .../CampaignControllerFindAllRequestSortBy.ts | 9 + .../CampaignControllerFindAllRequestStatus.ts | 2 + ...ampaignControllerFindAllV2RequestSortBy.ts | 9 + ...aignControllerFindAllV2RequestSortOrder.ts | 8 + ...ampaignControllerFindAllV2RequestStatus.ts | 11 + ...ollerGetCampaignV2ContactsRequestSortBy.ts | 8 + ...rGetCampaignV2ContactsRequestStatusItem.ts | 12 + src/api/resources/campaigns/types/index.ts | 7 +- src/api/resources/chats/client/Client.ts | 4 + .../chats/client/requests/ListChatsRequest.ts | 4 + .../chats/types/ListChatsRequestSortBy.ts | 8 + src/api/resources/chats/types/index.ts | 1 + src/api/resources/eval/client/Client.ts | 22 + .../EvalControllerGetPaginatedRequest.ts | 3 + .../requests/EvalControllerGetRequest.ts | 1 + .../requests/EvalControllerGetRunRequest.ts | 1 + .../EvalControllerGetRunsPaginatedRequest.ts | 3 + .../requests/EvalControllerRemoveRequest.ts | 1 + .../EvalControllerRemoveRunRequest.ts | 1 + .../eval/client/requests/UpdateEvalDto.ts | 1 + .../eval/types/CreateEvalRunDtoTarget.ts | 5 + ...EvalControllerGetPaginatedRequestSortBy.ts | 9 + ...ControllerGetRunsPaginatedRequestSortBy.ts | 9 + src/api/resources/eval/types/index.ts | 2 + src/api/resources/files/client/Client.ts | 41 +- .../files/client/requests/CreateFileDto.ts | 7 +- .../client/requests/DeleteFilesRequest.ts | 1 + .../files/client/requests/GetFilesRequest.ts | 1 + .../files/client/requests/ListFilesRequest.ts | 11 + .../files/client/requests/UpdateFileDto.ts | 1 + .../resources/files/client/requests/index.ts | 1 + src/api/resources/files/index.ts | 1 + .../files/types/CreateFilesRequestPurpose.ts | 9 + src/api/resources/files/types/index.ts | 1 + src/api/resources/index.ts | 21 + src/api/resources/insight/client/Client.ts | 16 + .../InsightControllerFindAllRequest.ts | 3 + .../InsightControllerFindOneRequest.ts | 1 + .../InsightControllerRemoveRequest.ts | 1 + .../InsightControllerUpdateRequest.ts | 1 + .../insight/client/requests/InsightRunDto.ts | 7 + .../InsightControllerFindAllRequestSortBy.ts | 9 + src/api/resources/insight/types/index.ts | 1 + .../knowledgeBasesV2/client/Client.ts | 572 + .../knowledgeBasesV2/client/index.ts | 1 + .../requests/AttachKnowledgeBaseV2FileDto.ts | 14 + .../requests/CreateKnowledgeBaseV2Dto.ts | 12 + ...wledgeBaseV2ControllerFileDetachRequest.ts | 14 + ...owledgeBaseV2ControllerFileRetryRequest.ts | 14 + ...nowledgeBaseV2ControllerFilesGetRequest.ts | 12 + ...KnowledgeBaseV2ControllerFindAllRequest.ts | 9 + ...KnowledgeBaseV2ControllerFindOneRequest.ts | 12 + .../KnowledgeBaseV2ControllerRemoveRequest.ts | 12 + .../requests/UpdateKnowledgeBaseV2Dto.ts | 14 + .../knowledgeBasesV2/client/requests/index.ts | 9 + src/api/resources/knowledgeBasesV2/exports.ts | 4 + src/api/resources/knowledgeBasesV2/index.ts | 1 + .../observabilityScorecard/client/Client.ts | 21 +- .../ScorecardControllerGetPaginatedRequest.ts | 3 + .../requests/ScorecardControllerGetRequest.ts | 1 + .../ScorecardControllerRemoveRequest.ts | 1 + .../client/requests/UpdateScorecardDto.ts | 1 + ...cardControllerGetPaginatedRequestSortBy.ts | 9 + .../observabilityScorecard/types/index.ts | 1 + .../resources/phoneNumbers/client/Client.ts | 14 + .../requests/DeletePhoneNumbersRequest.ts | 1 + .../client/requests/GetPhoneNumbersRequest.ts | 1 + ...NumberControllerFindAllPaginatedRequest.ts | 2 + .../requests/UpdatePhoneNumbersRequest.ts | 1 + ...ControllerFindAllPaginatedRequestSortBy.ts | 9 + src/api/resources/phoneNumbers/types/index.ts | 1 + .../providerResources/client/Client.ts | 12 + ...ControllerDeleteProviderResourceRequest.ts | 1 + ...rceControllerGetProviderResourceRequest.ts | 1 + ...lerGetProviderResourcesPaginatedRequest.ts | 4 + ...ControllerUpdateProviderResourceRequest.ts | 1 + ...ProviderResourcesPaginatedRequestSortBy.ts | 9 + .../providerResources/types/index.ts | 1 + src/api/resources/sessions/client/Client.ts | 6 + .../client/requests/DeleteSessionsRequest.ts | 1 + .../client/requests/GetSessionsRequest.ts | 1 + .../client/requests/ListSessionsRequest.ts | 10 + .../client/requests/UpdateSessionDto.ts | 1 + .../types/ListSessionsRequestSortBy.ts | 8 + src/api/resources/sessions/types/index.ts | 1 + .../simulationPersonalities/client/Client.ts | 370 + .../simulationPersonalities/client/index.ts | 1 + .../PersonalityControllerFindAllRequest.ts | 34 + .../PersonalityControllerFindOneRequest.ts | 12 + .../PersonalityControllerRemoveRequest.ts | 12 + .../client/requests}/UpdatePersonalityDto.ts | 16 +- .../client/requests/index.ts | 4 + .../simulationPersonalities/exports.ts | 4 + .../simulationPersonalities/index.ts | 2 + ...rsonalityControllerFindAllRequestSortBy.ts | 9 + ...nalityControllerFindAllRequestSortOrder.ts | 8 + .../simulationPersonalities/types/index.ts | 2 + .../resources/simulationRuns/client/Client.ts | 621 + .../resources/simulationRuns/client/index.ts | 1 + .../requests}/CreateSimulationRunDto.ts | 17 +- ...mulationRunControllerCancelGroupRequest.ts | 12 + ...imulationRunControllerCancelItemRequest.ts | 15 + .../SimulationRunControllerFindAllRequest.ts | 42 + .../SimulationRunControllerFindItemRequest.ts | 15 + ...SimulationRunControllerFindItemsRequest.ts | 44 + .../SimulationRunControllerFindOneRequest.ts | 12 + ...RunControllerGenerateSuggestionsRequest.ts | 19 + .../simulationRuns/client/requests/index.ts | 8 + src/api/resources/simulationRuns/exports.ts | 4 + src/api/resources/simulationRuns/index.ts | 2 + .../CreateSimulationRunDtoSimulationsItem.ts | 9 +- .../types/CreateSimulationRunDtoTarget.ts | 7 +- ...RunControllerFindAllRequestFilterStatus.ts | 9 + ...lationRunControllerFindAllRequestSortBy.ts | 9 + ...ionRunControllerFindAllRequestSortOrder.ts | 8 + ...lationRunControllerFindAllRequestStatus.ts | 9 + ...onRunControllerFindAllRequestTargetType.ts | 8 + .../SimulationRunControllerFindAllResponse.ts | 5 + ...tionRunControllerFindItemsRequestSortBy.ts | 9 + ...nRunControllerFindItemsRequestSortOrder.ts | 8 + ...tionRunControllerFindItemsRequestStatus.ts | 12 + .../resources/simulationRuns/types/index.ts | 11 + .../simulationScenarios/client/Client.ts | 378 + .../simulationScenarios/client/index.ts | 1 + .../ScenarioControllerFindAllRequest.ts | 38 + .../ScenarioControllerFindOneRequest.ts | 12 + .../ScenarioControllerRemoveRequest.ts | 12 + .../client/requests}/UpdateScenarioDto.ts | 24 +- .../client/requests/index.ts | 4 + .../resources/simulationScenarios/exports.ts | 4 + .../resources/simulationScenarios/index.ts | 2 + .../ScenarioControllerFindAllRequestSortBy.ts | 9 + ...enarioControllerFindAllRequestSortOrder.ts | 8 + .../types/UpdateScenarioDtoHooksItem.ts | 2 +- .../simulationScenarios/types/index.ts | 3 + .../simulationSuites/client/Client.ts | 362 + .../simulationSuites/client/index.ts | 1 + .../requests/CreateSimulationSuiteDto.ts | 27 + ...SimulationSuiteControllerFindAllRequest.ts | 36 + ...SimulationSuiteControllerFindOneRequest.ts | 12 + .../SimulationSuiteControllerRemoveRequest.ts | 12 + .../requests}/UpdateSimulationSuiteDto.ts | 20 +- .../simulationSuites/client/requests/index.ts | 5 + src/api/resources/simulationSuites/exports.ts | 4 + src/api/resources/simulationSuites/index.ts | 2 + ...tionSuiteControllerFindAllRequestSortBy.ts | 9 + ...nSuiteControllerFindAllRequestSortOrder.ts | 8 + .../resources/simulationSuites/types/index.ts | 2 + .../resources/simulations/client/Client.ts | 480 + src/api/resources/simulations/client/index.ts | 1 + .../client/requests}/CreateSimulationDto.ts | 17 +- .../client/requests}/GenerateScenariosDto.ts | 8 +- .../SimulationControllerFindAllRequest.ts | 38 + .../SimulationControllerFindOneRequest.ts | 12 + .../SimulationControllerRemoveRequest.ts | 12 + .../client/requests}/UpdateSimulationDto.ts | 16 +- .../simulations/client/requests/index.ts | 6 + src/api/resources/simulations/exports.ts | 4 + src/api/resources/simulations/index.ts | 2 + ...imulationControllerFindAllRequestSortBy.ts | 9 + ...lationControllerFindAllRequestSortOrder.ts | 8 + src/api/resources/simulations/types/index.ts | 2 + src/api/resources/squads/client/Client.ts | 12 + .../client/requests/DeleteSquadsRequest.ts | 1 + .../client/requests/GetSquadsRequest.ts | 1 + .../client/requests/ListSquadsRequest.ts | 2 + .../squads/client/requests/UpdateSquadDto.ts | 1 + .../structuredOutputs/client/Client.ts | 23 +- ...tructuredOutputControllerFindAllRequest.ts | 2 + ...tructuredOutputControllerFindOneRequest.ts | 1 + ...StructuredOutputControllerRemoveRequest.ts | 1 + .../requests/UpdateStructuredOutputDto.ts | 4 + ...redOutputControllerFindAllRequestSortBy.ts | 9 + .../StructuredOutputControllerRunResponse.ts | 7 + ...ructuredOutputControllerRunResponseZero.ts | 12 + ...UpdateStructuredOutputDtoConditionsItem.ts | 22 + .../structuredOutputs/types/index.ts | 4 + src/api/resources/tools/client/Client.ts | 29 +- .../client/requests/DeleteToolsRequest.ts | 1 + .../tools/client/requests/GetToolsRequest.ts | 1 + .../client/requests/UpdateToolsRequest.ts | 1 + .../tools/types/CreateToolsRequest.ts | 24 + .../tools/types/CreateToolsResponse.ts | 31 + .../tools/types/DeleteToolsResponse.ts | 31 + .../resources/tools/types/GetToolsResponse.ts | 31 + .../tools/types/ListToolsResponseItem.ts | 31 + .../tools/types/UpdateToolsRequestBody.ts | 30 + .../tools/types/UpdateToolsResponse.ts | 31 + src/api/types/AiEdgeCondition.ts | 4 + src/api/types/AiEdgeConditionType.ts | 1 + src/api/types/Analysis.ts | 3 + src/api/types/AnalysisCost.ts | 11 + src/api/types/AnalysisCostBreakdown.ts | 3 + src/api/types/AnalysisPlan.ts | 3 + src/api/types/AnalyticsOperation.ts | 3 + src/api/types/AnalyticsQuery.ts | 3 + src/api/types/AnalyticsQueryResult.ts | 3 + .../types/AnthropicBedrockCredentialRegion.ts | 1 + src/api/types/AnthropicBedrockModel.ts | 12 +- src/api/types/AnthropicBedrockModelModel.ts | 1 + .../types/AnthropicBedrockModelToolsItem.ts | 25 + src/api/types/AnthropicModel.ts | 12 +- src/api/types/AnthropicModelModel.ts | 1 + src/api/types/AnthropicModelToolsItem.ts | 25 + src/api/types/AnthropicThinkingConfig.ts | 4 + src/api/types/AnthropicThinkingConfigType.ts | 1 + src/api/types/AnyscaleModel.ts | 12 +- src/api/types/AnyscaleModelToolsItem.ts | 25 + src/api/types/ApiRequestTool.ts | 19 +- src/api/types/ApiRequestToolMethod.ts | 1 + src/api/types/Artifact.ts | 58 +- src/api/types/ArtifactPlan.ts | 9 + src/api/types/AssemblyAiTranscriber.ts | 20 +- .../AssemblyAiTranscriberLanguageCodesItem.ts | 24 + src/api/types/AssemblyAiTranscriberMode.ts | 13 + .../types/AssemblyAiTranscriberSpeechModel.ts | 4 +- src/api/types/Assistant.ts | 13 + src/api/types/AssistantActivation.ts | 10 + src/api/types/AssistantCredentialsItem.ts | 74 +- .../types/AssistantCustomEndpointingRule.ts | 3 + src/api/types/AssistantDraft.ts | 163 + .../types/AssistantDraftBackgroundSound.ts | 9 + .../AssistantDraftBackgroundSoundZero.ts | 8 + .../types/AssistantDraftClientMessagesItem.ts | 25 + .../AssistantDraftConflictResponseDto.ts | 7 + .../types/AssistantDraftCredentialsItem.ts | 352 + .../types/AssistantDraftFirstMessageMode.ts | 19 + src/api/types/AssistantDraftHooksItem.ts | 10 + src/api/types/AssistantDraftModel.ts | 117 + .../types/AssistantDraftPaginatedMetadata.ts | 7 + .../types/AssistantDraftPaginatedResponse.ts | 8 + .../types/AssistantDraftServerMessagesItem.ts | 34 + src/api/types/AssistantDraftTranscriber.ts | 80 + src/api/types/AssistantDraftVoice.ts | 110 + .../types/AssistantDraftVoicemailDetection.ts | 14 + .../AssistantDraftVoicemailDetectionZero.ts | 7 + src/api/types/AssistantMessage.ts | 3 + .../AssistantMessageEvaluationContinuePlan.ts | 3 + src/api/types/AssistantMessageJudgePlanAi.ts | 3 + .../types/AssistantMessageJudgePlanExact.ts | 3 + .../types/AssistantMessageJudgePlanRegex.ts | 3 + src/api/types/AssistantModel.ts | 29 +- src/api/types/AssistantOverrides.ts | 7 + .../AssistantOverridesCredentialsItem.ts | 74 +- src/api/types/AssistantOverridesModel.ts | 29 +- .../AssistantOverridesServerMessagesItem.ts | 1 + .../AssistantOverridesToolsAppendItem.ts | 25 + .../types/AssistantOverridesTranscriber.ts | 12 +- src/api/types/AssistantOverridesVoice.ts | 12 +- .../AssistantPinnedConflictResponseDto.ts | 9 + ...AssistantPinnedConflictResponseDtoError.ts | 7 + src/api/types/AssistantServerMessagesItem.ts | 1 + src/api/types/AssistantTranscriber.ts | 12 +- src/api/types/AssistantVersion.ts | 178 + .../types/AssistantVersionBackgroundSound.ts | 9 + .../AssistantVersionBackgroundSoundZero.ts | 8 + .../AssistantVersionClientMessagesItem.ts | 25 + .../types/AssistantVersionCredentialsItem.ts | 352 + .../types/AssistantVersionFirstMessageMode.ts | 19 + src/api/types/AssistantVersionHooksItem.ts | 10 + src/api/types/AssistantVersionModel.ts | 117 + .../AssistantVersionPaginatedMetadata.ts | 7 + .../AssistantVersionPaginatedResponse.ts | 5 +- .../AssistantVersionServerMessagesItem.ts | 34 + src/api/types/AssistantVersionTranscriber.ts | 80 + src/api/types/AssistantVersionVoice.ts | 110 + .../AssistantVersionVoicemailDetection.ts | 14 + .../AssistantVersionVoicemailDetectionZero.ts | 7 + src/api/types/AssistantVoice.ts | 12 +- src/api/types/AudioFormat.ts | 24 + src/api/types/AudioFormatContainer.ts | 11 + src/api/types/AwsStsAuthenticationPlan.ts | 3 + .../AwsiamCredentialsAuthenticationPlan.ts | 3 + src/api/types/AzureBlobStorageBucketPlan.ts | 3 + src/api/types/AzureCredentialRegion.ts | 2 + .../types/AzureOpenAiCredentialModelsItem.ts | 6 + src/api/types/AzureOpenAiCredentialRegion.ts | 2 + src/api/types/AzureSpeechTranscriber.ts | 3 + src/api/types/AzureVoice.ts | 3 + .../types/BackgroundSpeechDenoisingPlan.ts | 3 + src/api/types/BackoffPlan.ts | 10 +- src/api/types/BarInsight.ts | 6 + src/api/types/BarInsightMetadata.ts | 8 + src/api/types/BashTool.ts | 10 +- src/api/types/BashToolWithToolCall.ts | 6 +- src/api/types/BearerAuthenticationPlan.ts | 3 + src/api/types/Board.ts | 31 + src/api/types/BoardInsightItem.ts | 11 + src/api/types/BoardInsightItemType.ts | 6 + src/api/types/BoardItemPosition.ts | 6 + src/api/types/BoardItemSize.ts | 6 + src/api/types/BoardItemsItem.ts | 5 + src/api/types/BoardLayout.ts | 9 + src/api/types/BoardMetricWidgetItem.ts | 11 + src/api/types/BoardMetricWidgetItemType.ts | 8 + src/api/types/BoardPaginatedResponse.ts | 8 + ...oleanComparatorScorecardMetricCondition.ts | 20 + ...ratorScorecardMetricConditionComparator.ts | 8 + ...nComparatorScorecardMetricConditionType.ts | 8 + src/api/types/BotMessage.ts | 14 + src/api/types/BothCustomEndpointingRule.ts | 4 + src/api/types/BucketPlan.ts | 3 + src/api/types/ByoPhoneNumber.ts | 3 + src/api/types/ByoSipTrunkCredential.ts | 2 - src/api/types/Call.ts | 15 +- src/api/types/CallArtifactUploadItem.ts | 10 + src/api/types/CallArtifactUploadItemType.ts | 13 + src/api/types/CallBatchError.ts | 5 + src/api/types/CallBatchResponse.ts | 3 + src/api/types/CallEndedReason.ts | 30 + .../CallHookAssistantSpeechInterrupted.ts | 3 + ...allHookAssistantSpeechInterruptedDoItem.ts | 5 + src/api/types/CallHookCallEnding.ts | 3 + src/api/types/CallHookCallEndingDoItem.ts | 2 + .../CallHookCustomerSpeechInterrupted.ts | 3 + ...CallHookCustomerSpeechInterruptedDoItem.ts | 5 + .../types/CallHookCustomerSpeechTimeout.ts | 5 +- .../CallHookCustomerSpeechTimeoutDoItem.ts | 5 + src/api/types/CallHookFilter.ts | 3 + src/api/types/CallHookModelResponseTimeout.ts | 3 + .../CallHookModelResponseTimeoutDoItem.ts | 5 + ...iberEndpointedSpeechLowConfidenceDoItem.ts | 5 + src/api/types/CallTransport.ts | 40 + src/api/types/Campaign.ts | 17 +- src/api/types/CampaignCallMetrics.ts | 15 + src/api/types/CampaignContact.ts | 16 + src/api/types/CampaignContactCounters.ts | 10 + .../types/CampaignContactPaginatedResponse.ts | 8 + src/api/types/CampaignContactWithOutcome.ts | 13 + .../types/CampaignContactWithOutcomeStatus.ts | 12 + src/api/types/CampaignPaginatedResponse.ts | 5 + src/api/types/CampaignPredialPlan.ts | 6 + src/api/types/CampaignServerMessagesItem.ts | 16 + src/api/types/CampaignStatus.ts | 2 + src/api/types/CampaignSummary.ts | 51 + src/api/types/CampaignSummaryEndedReason.ts | 9 + .../types/CampaignSummaryPaginatedResponse.ts | 8 + .../CampaignSummaryServerMessagesItem.ts | 17 + src/api/types/CampaignSummaryStatus.ts | 11 + src/api/types/CartesiaCredential.ts | 2 + src/api/types/CartesiaExperimentalControls.ts | 5 + .../CartesiaExperimentalControlsEmotion.ts | 1 + src/api/types/CartesiaGenerationConfig.ts | 3 + .../CartesiaGenerationConfigExperimental.ts | 3 + src/api/types/CartesiaSpeedControl.ts | 3 + src/api/types/CartesiaTranscriber.ts | 5 + src/api/types/CartesiaTranscriberLanguage.ts | 1 + src/api/types/CartesiaTranscriberModel.ts | 2 + src/api/types/CartesiaVoice.ts | 3 + src/api/types/CartesiaVoiceModel.ts | 2 + src/api/types/CerebrasModel.ts | 12 +- src/api/types/CerebrasModelToolsItem.ts | 25 + .../ChatEvalAssistantMessageEvaluation.ts | 3 + src/api/types/ChatEvalAssistantMessageMock.ts | 3 + .../ChatEvalAssistantMessageMockToolCall.ts | 3 + src/api/types/ChatEvalSystemMessageMock.ts | 3 + .../ChatEvalToolResponseMessageEvaluation.ts | 3 + .../types/ChatEvalToolResponseMessageMock.ts | 3 + src/api/types/ChatEvalUserMessageMock.ts | 3 + src/api/types/ChunkPlan.ts | 3 + src/api/types/ClientMessageAssistantSpeech.ts | 7 + .../types/ClientMessageAssistantStarted.ts | 7 + .../types/ClientMessageCallDeleteFailed.ts | 7 + src/api/types/ClientMessageCallDeleted.ts | 7 + src/api/types/ClientMessageChatCreated.ts | 7 + src/api/types/ClientMessageChatDeleted.ts | 7 + .../types/ClientMessageConversationUpdate.ts | 7 + src/api/types/ClientMessageHang.ts | 7 + .../ClientMessageLanguageChangeDetected.ts | 7 + src/api/types/ClientMessageMetadata.ts | 7 + src/api/types/ClientMessageModelOutput.ts | 7 + src/api/types/ClientMessageSessionCreated.ts | 7 + src/api/types/ClientMessageSessionDeleted.ts | 7 + src/api/types/ClientMessageSessionUpdated.ts | 7 + src/api/types/ClientMessageSpeechUpdate.ts | 7 + src/api/types/ClientMessageToolCalls.ts | 7 + src/api/types/ClientMessageToolCallsResult.ts | 7 + src/api/types/ClientMessageTranscript.ts | 17 + src/api/types/ClientMessageTransferUpdate.ts | 7 + src/api/types/ClientMessageUserInterrupted.ts | 7 + src/api/types/ClientMessageVoiceInput.ts | 7 + .../types/ClientMessageWorkflowNodeStarted.ts | 7 + src/api/types/CloudflareR2BucketPlan.ts | 3 + src/api/types/CodeTool.ts | 10 +- src/api/types/CodeToolEnvironmentVariable.ts | 3 + src/api/types/Compliance.ts | 3 + src/api/types/ComplianceOverride.ts | 3 + src/api/types/CompliancePlan.ts | 4 + .../CompliancePlanRecordingConsentPlan.ts | 3 + src/api/types/ComputerTool.ts | 10 +- src/api/types/ComputerToolWithToolCall.ts | 6 +- src/api/types/Condition.ts | 3 + src/api/types/ContextEngineeringPlanAll.ts | 3 + .../ContextEngineeringPlanLastNMessages.ts | 3 + src/api/types/ContextEngineeringPlanNone.ts | 3 + ...ngineeringPlanPreviousAssistantMessages.ts | 3 + ...EngineeringPlanUserAndAssistantMessages.ts | 3 + src/api/types/ConversationNode.ts | 5 + src/api/types/ConversationNodeToolsItem.ts | 25 + src/api/types/ConversationNodeTranscriber.ts | 12 +- src/api/types/ConversationNodeVoice.ts | 12 +- src/api/types/CostBreakdown.ts | 3 + .../CreateAnthropicBedrockCredentialDto.ts | 3 + ...eateAnthropicBedrockCredentialDtoRegion.ts | 1 + src/api/types/CreateAnthropicCredentialDto.ts | 3 + src/api/types/CreateAnyscaleCredentialDto.ts | 3 + src/api/types/CreateApiRequestToolDto.ts | 18 +- .../types/CreateApiRequestToolDtoMethod.ts | 1 + .../types/CreateAssemblyAiCredentialDto.ts | 3 + src/api/types/CreateAssistantDraftDto.ts | 159 + .../CreateAssistantDraftDtoBackgroundSound.ts | 9 + ...ateAssistantDraftDtoBackgroundSoundZero.ts | 8 + ...eateAssistantDraftDtoClientMessagesItem.ts | 25 + .../CreateAssistantDraftDtoCredentialsItem.ts | 352 + ...CreateAssistantDraftDtoFirstMessageMode.ts | 19 + .../types/CreateAssistantDraftDtoHooksItem.ts | 10 + src/api/types/CreateAssistantDraftDtoModel.ts | 117 + ...eateAssistantDraftDtoServerMessagesItem.ts | 34 + .../CreateAssistantDraftDtoTranscriber.ts | 80 + src/api/types/CreateAssistantDraftDtoVoice.ts | 110 + ...eateAssistantDraftDtoVoicemailDetection.ts | 14 + ...AssistantDraftDtoVoicemailDetectionZero.ts | 7 + src/api/types/CreateAssistantDto.ts | 6 + .../CreateAssistantDtoCredentialsItem.ts | 74 +- src/api/types/CreateAssistantDtoModel.ts | 29 +- .../CreateAssistantDtoServerMessagesItem.ts | 1 + .../types/CreateAssistantDtoTranscriber.ts | 12 +- src/api/types/CreateAssistantDtoVoice.ts | 12 +- src/api/types/CreateAzureCredentialDto.ts | 3 + .../types/CreateAzureCredentialDtoRegion.ts | 2 + .../types/CreateAzureOpenAiCredentialDto.ts | 6 + ...reateAzureOpenAiCredentialDtoModelsItem.ts | 6 + .../CreateAzureOpenAiCredentialDtoRegion.ts | 3 + .../types/CreateBarInsightFromCallTableDto.ts | 4 + src/api/types/CreateBashToolDto.ts | 9 +- src/api/types/CreateByoPhoneNumberDto.ts | 3 + .../types/CreateByoSipTrunkCredentialDto.ts | 5 +- src/api/types/CreateCampaignDto.ts | 39 + .../CreateCampaignDtoServerMessagesItem.ts | 17 + src/api/types/CreateCartesiaCredentialDto.ts | 5 + src/api/types/CreateCerebrasCredentialDto.ts | 3 + .../types/CreateCloudflareCredentialDto.ts | 3 + src/api/types/CreateCodeToolDto.ts | 9 +- src/api/types/CreateComputerToolDto.ts | 9 +- src/api/types/CreateCustomCredentialDto.ts | 3 + src/api/types/CreateCustomKnowledgeBaseDto.ts | 3 + src/api/types/CreateCustomLlmCredentialDto.ts | 3 + src/api/types/CreateCustomerDto.ts | 9 + src/api/types/CreateDeepInfraCredentialDto.ts | 3 + src/api/types/CreateDeepSeekCredentialDto.ts | 3 + src/api/types/CreateDeepgramCredentialDto.ts | 3 + src/api/types/CreateDtmfToolDto.ts | 9 +- .../types/CreateElevenLabsCredentialDto.ts | 7 + .../CreateElevenLabsCredentialDtoApiUrl.ts | 9 + src/api/types/CreateEmailCredentialDto.ts | 3 + src/api/types/CreateEndCallToolDto.ts | 9 +- src/api/types/CreateEvalDto.ts | 3 + src/api/types/CreateFunctionToolDto.ts | 9 +- src/api/types/CreateGcpCredentialDto.ts | 4 + src/api/types/CreateGhlToolDto.ts | 6 +- src/api/types/CreateGladiaCredentialDto.ts | 3 + ...eGoHighLevelCalendarAvailabilityToolDto.ts | 9 +- ...teGoHighLevelCalendarEventCreateToolDto.ts | 9 +- .../CreateGoHighLevelContactCreateToolDto.ts | 9 +- .../CreateGoHighLevelContactGetToolDto.ts | 9 +- .../types/CreateGoHighLevelCredentialDto.ts | 3 + .../CreateGoHighLevelMcpCredentialDto.ts | 3 + ...eGoogleCalendarCheckAvailabilityToolDto.ts | 9 +- .../CreateGoogleCalendarCreateEventToolDto.ts | 9 +- ...alendarOAuth2AuthorizationCredentialDto.ts | 3 + ...GoogleCalendarOAuth2ClientCredentialDto.ts | 3 + src/api/types/CreateGoogleCredentialDto.ts | 3 + ...eSheetsOAuth2AuthorizationCredentialDto.ts | 3 + .../CreateGoogleSheetsRowAppendToolDto.ts | 9 +- src/api/types/CreateGroqCredentialDto.ts | 3 + src/api/types/CreateHandoffToolDto.ts | 9 +- .../CreateHandoffToolDtoDestinationsItem.ts | 5 + src/api/types/CreateHumeCredentialDto.ts | 3 + .../types/CreateInflectionAiCredentialDto.ts | 3 + src/api/types/CreateInworldCredentialDto.ts | 3 + src/api/types/CreateLangfuseCredentialDto.ts | 3 + .../CreateLineInsightFromCallTableDto.ts | 4 + src/api/types/CreateLmntCredentialDto.ts | 3 + src/api/types/CreateMakeCredentialDto.ts | 3 + src/api/types/CreateMakeToolDto.ts | 6 +- src/api/types/CreateMcpToolDto.ts | 10 +- src/api/types/CreateMicrosoftCredentialDto.ts | 10 + src/api/types/CreateMinimaxCredentialDto.ts | 3 + src/api/types/CreateMistralCredentialDto.ts | 3 + src/api/types/CreateNeuphonicCredentialDto.ts | 3 + src/api/types/CreateOpenAiCredentialDto.ts | 3 + .../types/CreateOpenRouterCredentialDto.ts | 3 + src/api/types/CreateOutboundCallDto.ts | 9 +- .../types/CreateOutboundCallDtoTransport.ts | 40 + src/api/types/CreateOutputToolDto.ts | 6 +- .../types/CreatePerplexityAiCredentialDto.ts | 3 + src/api/types/CreatePersonalityDto.ts | 7 +- .../types/CreatePieInsightFromCallTableDto.ts | 4 + src/api/types/CreatePlayHtCredentialDto.ts | 4 + src/api/types/CreateQueryToolDto.ts | 9 +- src/api/types/CreateRimeAiCredentialDto.ts | 3 + src/api/types/CreateRunpodCredentialDto.ts | 3 + .../types/CreateS3CompatibleCredentialDto.ts | 11 + src/api/types/CreateS3CredentialDto.ts | 3 + src/api/types/CreateScenarioDto.ts | 11 +- src/api/types/CreateScorecardDto.ts | 3 + src/api/types/CreateSesameVoiceDto.ts | 11 +- src/api/types/CreateSimulationRunResponse.ts | 40 + ...ateSimulationRunResponseSimulationsItem.ts | 24 + .../CreateSimulationRunResponseStatus.ts | 10 + .../CreateSimulationRunResponseTarget.ts | 27 + src/api/types/CreateSimulationSuiteDto.ts | 16 - src/api/types/CreateSipRequestToolDto.ts | 9 +- ...teSlackOAuth2AuthorizationCredentialDto.ts | 3 + .../types/CreateSlackSendMessageToolDto.ts | 9 +- .../types/CreateSlackWebhookCredentialDto.ts | 3 + .../types/CreateSmallestAiCredentialDto.ts | 3 + src/api/types/CreateSmsToolDto.ts | 9 +- src/api/types/CreateSonioxCredentialDto.ts | 5 + .../types/CreateSpeechmaticsCredentialDto.ts | 3 + src/api/types/CreateSquadDto.ts | 3 + src/api/types/CreateStructuredOutputDto.ts | 5 + ...CreateStructuredOutputDtoConditionsItem.ts | 22 + src/api/types/CreateSupabaseCredentialDto.ts | 4 + src/api/types/CreateTavusCredentialDto.ts | 3 + src/api/types/CreateTelnyxPhoneNumberDto.ts | 3 + src/api/types/CreateTextEditorToolDto.ts | 9 +- .../CreateTextInsightFromCallTableDto.ts | 4 + .../types/CreateTogetherAiCredentialDto.ts | 3 + src/api/types/CreateToolDraftDto.ts | 163 + .../types/CreateToolDraftDtoMessagesItem.ts | 27 + src/api/types/CreateToolDraftDtoMethod.ts | 11 + src/api/types/CreateToolDraftDtoType.ts | 35 + src/api/types/CreateToolDraftDtoVerb.ts | 9 + src/api/types/CreateToolTemplateDtoDetails.ts | 25 + src/api/types/CreateTransferCallToolDto.ts | 9 +- src/api/types/CreateTrieveCredentialDto.ts | 9 +- src/api/types/CreateTrieveKnowledgeBaseDto.ts | 23 +- .../CreateTrieveKnowledgeBaseDtoProvider.ts | 12 - src/api/types/CreateTwilioCredentialDto.ts | 4 + src/api/types/CreateTwilioPhoneNumberDto.ts | 3 + src/api/types/CreateVapiPhoneNumberDto.ts | 3 + src/api/types/CreateVoicemailToolDto.ts | 9 +- src/api/types/CreateVonageCredentialDto.ts | 4 + src/api/types/CreateVonagePhoneNumberDto.ts | 3 + src/api/types/CreateWebCallDto.ts | 5 + src/api/types/CreateWellSaidCredentialDto.ts | 3 + src/api/types/CreateWorkflowDto.ts | 7 + .../types/CreateWorkflowDtoCredentialsItem.ts | 74 +- src/api/types/CreateWorkflowDtoNodesItem.ts | 2 + src/api/types/CreateWorkflowDtoTranscriber.ts | 12 +- src/api/types/CreateWorkflowDtoVoice.ts | 12 +- src/api/types/CreateXAiCredentialDto.ts | 3 + ...tomEndpointingModelSmartEndpointingPlan.ts | 3 + src/api/types/CustomLlmModel.ts | 12 +- src/api/types/CustomLlmModelToolsItem.ts | 25 + src/api/types/CustomMessage.ts | 3 + src/api/types/CustomTranscriber.ts | 3 + src/api/types/CustomVoice.ts | 3 + .../types/CustomerCustomEndpointingRule.ts | 3 + src/api/types/CustomerSpeechTimeoutOptions.ts | 15 +- ...merSpeechTimeoutOptionsTriggerResetMode.ts | 9 + src/api/types/DeepInfraModel.ts | 12 +- src/api/types/DeepInfraModelToolsItem.ts | 25 + src/api/types/DeepSeekModel.ts | 12 +- src/api/types/DeepSeekModelToolsItem.ts | 25 + src/api/types/DeepgramTranscriber.ts | 26 +- .../types/DeepgramTranscriberRedactionItem.ts | 10 + src/api/types/DeepgramVoice.ts | 3 + src/api/types/DeepgramVoiceId.ts | 7 + src/api/types/DeveloperMessage.ts | 3 + src/api/types/DialPlanEntry.ts | 3 + src/api/types/DtmfTool.ts | 10 +- src/api/types/Edge.ts | 6 + src/api/types/ElevenLabsCredential.ts | 4 + src/api/types/ElevenLabsCredentialApiUrl.ts | 8 + ...levenLabsPronunciationDictionaryLocator.ts | 11 +- src/api/types/ElevenLabsTranscriber.ts | 3 + src/api/types/ElevenLabsVoice.ts | 3 + src/api/types/EndCallTool.ts | 10 +- src/api/types/EndedReasonCondition.ts | 20 + src/api/types/EndedReasonConditionOperator.ts | 14 + src/api/types/Eval.ts | 7 + src/api/types/EvalAnthropicModel.ts | 3 + src/api/types/EvalAnthropicModelModel.ts | 1 + src/api/types/EvalCustomModel.ts | 3 + src/api/types/EvalGoogleModel.ts | 3 + src/api/types/EvalGoogleModelModel.ts | 2 + src/api/types/EvalGroqModelModel.ts | 1 - src/api/types/EvalOpenAiModel.ts | 3 + src/api/types/EvalOpenAiModelModel.ts | 37 + src/api/types/EvalPaginatedResponse.ts | 5 + src/api/types/EvalRun.ts | 8 + src/api/types/EvalRunPaginatedResponse.ts | 5 + src/api/types/EvalRunResult.ts | 3 + src/api/types/EvalRunTarget.ts | 5 + src/api/types/EvalRunTargetAssistant.ts | 3 + src/api/types/EvalRunTargetSquad.ts | 3 + src/api/types/EvaluationPlanItem.ts | 31 +- src/api/types/EvaluationPlanItemComparator.ts | 8 +- src/api/types/EvaluationPlanItemValue.ts | 3 +- src/api/types/EventsTableBooleanCondition.ts | 3 + src/api/types/EventsTableNumberCondition.ts | 3 + src/api/types/EventsTableStringCondition.ts | 3 + src/api/types/ExactReplacement.ts | 3 + src/api/types/ExportChatDto.ts | 4 + src/api/types/ExportChatDtoSortBy.ts | 9 + src/api/types/ExportSessionDto.ts | 4 + src/api/types/ExportSessionDtoSortBy.ts | 9 + .../types/FallbackAssemblyAiTranscriber.ts | 20 +- ...kAssemblyAiTranscriberLanguageCodesItem.ts | 24 + .../FallbackAssemblyAiTranscriberMode.ts | 14 + ...allbackAssemblyAiTranscriberSpeechModel.ts | 4 +- .../types/FallbackAzureSpeechTranscriber.ts | 3 + src/api/types/FallbackAzureVoice.ts | 3 + src/api/types/FallbackCartesiaTranscriber.ts | 5 + .../FallbackCartesiaTranscriberLanguage.ts | 1 + .../types/FallbackCartesiaTranscriberModel.ts | 2 + src/api/types/FallbackCartesiaVoice.ts | 3 + src/api/types/FallbackCartesiaVoiceModel.ts | 2 + src/api/types/FallbackCustomTranscriber.ts | 3 + src/api/types/FallbackCustomVoice.ts | 3 + src/api/types/FallbackDeepgramTranscriber.ts | 26 +- ...allbackDeepgramTranscriberRedactionItem.ts | 10 + src/api/types/FallbackDeepgramVoice.ts | 3 + src/api/types/FallbackDeepgramVoiceId.ts | 7 + .../types/FallbackElevenLabsTranscriber.ts | 3 + src/api/types/FallbackElevenLabsVoice.ts | 3 + src/api/types/FallbackGladiaTranscriber.ts | 5 +- ...FallbackGladiaTranscriberLanguagesItem.ts} | 6 +- src/api/types/FallbackGoogleTranscriber.ts | 3 + .../types/FallbackGoogleTranscriberModel.ts | 2 + src/api/types/FallbackHumeVoice.ts | 3 + src/api/types/FallbackInworldVoice.ts | 3 + src/api/types/FallbackLmntVoice.ts | 3 + src/api/types/FallbackMicrosoftVoice.ts | 20 + src/api/types/FallbackMicrosoftVoiceRole.ts | 14 + src/api/types/FallbackMicrosoftVoiceStyle.ts | 36 + .../types/FallbackMicrosoftVoiceVoiceId.ts | 53 + src/api/types/FallbackNeuphonicVoice.ts | 3 + src/api/types/FallbackOpenAiTranscriber.ts | 3 + src/api/types/FallbackOpenAiVoice.ts | 3 + src/api/types/FallbackPlan.ts | 3 + src/api/types/FallbackPlanVoicesItem.ts | 12 +- src/api/types/FallbackPlayHtVoice.ts | 3 + src/api/types/FallbackRimeAiVoice.ts | 3 + src/api/types/FallbackSesameVoice.ts | 3 + src/api/types/FallbackSmallestAiVoice.ts | 3 + src/api/types/FallbackSonioxTranscriber.ts | 11 +- .../FallbackSonioxTranscriberLanguage.ts | 2 +- .../FallbackSonioxTranscriberLanguagesItem.ts | 191 + .../types/FallbackSonioxTranscriberModel.ts | 1 + .../types/FallbackSpeechmaticsTranscriber.ts | 5 + ...FallbackSpeechmaticsTranscriberLanguage.ts | 1 + .../types/FallbackTalkscriberTranscriber.ts | 3 + src/api/types/FallbackTavusVoice.ts | 3 + src/api/types/FallbackTranscriberPlan.ts | 6 +- ...FallbackTranscriberPlanTranscribersItem.ts | 7 +- src/api/types/FallbackVapiVoice.ts | 11 +- src/api/types/FallbackVapiVoiceLanguage.ts | 63 + src/api/types/FallbackVapiVoiceVersion.ts | 9 + src/api/types/FallbackVapiVoiceVoiceId.ts | 36 - src/api/types/FallbackWellSaidVoice.ts | 3 + src/api/types/FallbackXaiTranscriber.ts | 10 + .../types/FallbackXaiTranscriberLanguage.ts | 32 + src/api/types/FallbackXaiTranscriberModel.ts | 8 + src/api/types/FallbackXaiVoice.ts | 16 + src/api/types/FallbackXaiVoiceLanguage.ts | 27 + src/api/types/FallbackXaiVoiceVoiceId.ts | 11 + src/api/types/FileObject.ts | 1 + src/api/types/FileStatus.ts | 1 + src/api/types/File_.ts | 16 + .../types/FilterDateTypeColumnOnCallTable.ts | 3 + .../FilterNumberArrayTypeColumnOnCallTable.ts | 3 + .../FilterNumberTypeColumnOnCallTable.ts | 3 + .../FilterStringArrayTypeColumnOnCallTable.ts | 3 + .../FilterStringTypeColumnOnCallTable.ts | 3 + ...FilterStructuredOutputColumnOnCallTable.ts | 3 + src/api/types/FormatPlan.ts | 3 + src/api/types/FourierDenoisingPlan.ts | 3 + src/api/types/FunctionCallHookAction.ts | 6 +- src/api/types/FunctionTool.ts | 10 +- src/api/types/FunctionToolWithToolCall.ts | 6 +- src/api/types/GcpKey.ts | 3 + ...GeminiMultimodalLivePrebuiltVoiceConfig.ts | 4 + ...timodalLivePrebuiltVoiceConfigVoiceName.ts | 1 + .../types/GeminiMultimodalLiveSpeechConfig.ts | 4 + .../types/GeminiMultimodalLiveVoiceConfig.ts | 4 + src/api/types/GetChatPaginatedDto.ts | 4 + src/api/types/GetChatPaginatedDtoSortBy.ts | 9 + src/api/types/GetEvalPaginatedDto.ts | 2 + src/api/types/GetEvalPaginatedDtoSortBy.ts | 9 + src/api/types/GetEvalRunPaginatedDto.ts | 2 + src/api/types/GetEvalRunPaginatedDtoSortBy.ts | 10 + src/api/types/GetSessionPaginatedDto.ts | 4 + src/api/types/GetSessionPaginatedDtoSortBy.ts | 10 + src/api/types/GetToolDraftsDto.ts | 9 + src/api/types/GhlTool.ts | 7 +- src/api/types/GhlToolMetadata.ts | 5 + src/api/types/GhlToolWithToolCall.ts | 6 +- .../types/GladiaCustomVocabularyConfigDto.ts | 3 + src/api/types/GladiaTranscriber.ts | 5 +- ...s.ts => GladiaTranscriberLanguagesItem.ts} | 7 +- src/api/types/GladiaVocabularyItemDto.ts | 3 + src/api/types/GlobalNodePlan.ts | 3 + .../GoHighLevelCalendarAvailabilityTool.ts | 10 +- ...velCalendarAvailabilityToolWithToolCall.ts | 6 +- .../GoHighLevelCalendarEventCreateTool.ts | 10 +- ...evelCalendarEventCreateToolWithToolCall.ts | 6 +- src/api/types/GoHighLevelContactCreateTool.ts | 10 +- ...oHighLevelContactCreateToolWithToolCall.ts | 6 +- src/api/types/GoHighLevelContactGetTool.ts | 10 +- .../GoHighLevelContactGetToolWithToolCall.ts | 6 +- .../GoogleCalendarCheckAvailabilityTool.ts | 10 +- .../types/GoogleCalendarCreateEventTool.ts | 10 +- ...ogleCalendarCreateEventToolWithToolCall.ts | 6 +- src/api/types/GoogleModel.ts | 12 +- src/api/types/GoogleModelModel.ts | 2 + src/api/types/GoogleModelToolsItem.ts | 25 + src/api/types/GoogleRealtimeConfig.ts | 3 + src/api/types/GoogleSheetsRowAppendTool.ts | 10 +- .../GoogleSheetsRowAppendToolWithToolCall.ts | 6 +- src/api/types/GoogleTranscriber.ts | 3 + src/api/types/GoogleTranscriberModel.ts | 2 + src/api/types/GoogleVoicemailDetectionPlan.ts | 3 + src/api/types/GroqModel.ts | 12 +- src/api/types/GroqModelModel.ts | 1 - src/api/types/GroqModelToolsItem.ts | 25 + src/api/types/GroupCondition.ts | 3 + src/api/types/HandoffDestinationAssistant.ts | 4 + ...tinationAssistantContextEngineeringPlan.ts | 7 +- .../types/HandoffDestinationAssistantType.ts | 1 + src/api/types/HandoffDestinationDynamic.ts | 3 + src/api/types/HandoffDestinationSquad.ts | 3 + ...fDestinationSquadContextEngineeringPlan.ts | 7 +- src/api/types/HandoffTool.ts | 10 +- src/api/types/HandoffToolDestinationsItem.ts | 5 + src/api/types/HmacAuthenticationPlan.ts | 3 + src/api/types/HumeVoice.ts | 3 + src/api/types/ImportTwilioPhoneNumberDto.ts | 3 + src/api/types/InflectionAiModel.ts | 12 +- src/api/types/InflectionAiModelToolsItem.ts | 25 + src/api/types/Insight.ts | 5 + src/api/types/InsightFormula.ts | 3 + src/api/types/InsightPaginatedResponse.ts | 5 + src/api/types/InsightRunFormatPlan.ts | 3 + src/api/types/InsightRunResponse.ts | 8 + src/api/types/InsightTimeRange.ts | 3 + src/api/types/InsightTimeRangeWithStep.ts | 3 + src/api/types/InviteUserDtoRole.ts | 9 +- src/api/types/InviteUserDtoRoleZero.ts | 8 + src/api/types/InworldVoice.ts | 3 + ...sonQueryOnCallTableWithNumberTypeColumn.ts | 3 + ...sonQueryOnCallTableWithStringTypeColumn.ts | 3 + ...ryOnCallTableWithStructuredOutputColumn.ts | 3 + src/api/types/JsonQueryOnEventsTable.ts | 3 + src/api/types/JsonQueryOnEventsTableOn.ts | 4 + src/api/types/JsonSchema.ts | 3 + src/api/types/KeypadInputPlan.ts | 3 + src/api/types/KnowledgeBase.ts | 3 + src/api/types/KnowledgeBaseCost.ts | 3 + src/api/types/KnowledgeBaseModel.ts | 2 + src/api/types/KnowledgeBaseTool.ts | 101 + src/api/types/KnowledgeBaseToolFunction.ts | 28 + .../types/KnowledgeBaseToolMessagesItem.ts | 27 + src/api/types/KnowledgeBaseV2.ts | 10 + src/api/types/KnowledgeBaseV2File.ts | 15 + src/api/types/KnowledgeBaseV2FileStatus.ts | 8 + src/api/types/KnowledgeBaseV2WithFiles.ts | 15 + src/api/types/LangfuseObservabilityPlan.ts | 4 + .../LangfuseObservabilityPlanProvider.ts | 1 + src/api/types/LegacyAssistantVersion.ts | 9 + ...LegacyAssistantVersionPaginatedResponse.ts | 9 + src/api/types/LineInsight.ts | 6 + src/api/types/LineInsightMetadata.ts | 8 + src/api/types/LiquidCondition.ts | 3 + src/api/types/LivekitSmartEndpointingPlan.ts | 3 + src/api/types/LmntVoice.ts | 3 + src/api/types/MakeTool.ts | 7 +- src/api/types/MakeToolWithToolCall.ts | 6 +- src/api/types/McpTool.ts | 11 +- src/api/types/McpToolMessages.ts | 5 +- src/api/types/McpToolMetadata.ts | 3 + src/api/types/MessageAddHookAction.ts | 3 + src/api/types/MessageTarget.ts | 3 + ...veCredential.ts => MicrosoftCredential.ts} | 6 +- src/api/types/MicrosoftCredentialProvider.ts | 7 + src/api/types/MicrosoftVoice.ts | 22 + src/api/types/MicrosoftVoiceRole.ts | 14 + src/api/types/MicrosoftVoiceStyle.ts | 35 + src/api/types/MicrosoftVoiceVoiceId.ts | 52 + src/api/types/MinCallDurationCondition.ts | 12 + src/api/types/MinMessagesCondition.ts | 12 + src/api/types/MinimaxLlmModel.ts | 12 +- src/api/types/MinimaxLlmModelToolsItem.ts | 25 + src/api/types/MinimaxVoice.ts | 3 + src/api/types/ModelCost.ts | 9 + src/api/types/Monitor.ts | 4 + src/api/types/MonitorPlan.ts | 11 +- src/api/types/MonitorResult.ts | 5 + src/api/types/Mono.ts | 3 + src/api/types/NeuphonicVoice.ts | 3 + src/api/types/NodeArtifact.ts | 3 + ...umberComparatorScorecardMetricCondition.ts | 24 + ...ratorScorecardMetricConditionComparator.ts | 17 + ...rComparatorScorecardMetricConditionType.ts | 8 + src/api/types/OAuth2AuthenticationPlan.ts | 4 + src/api/types/OAuth2AuthenticationPlanType.ts | 1 + src/api/types/Oauth2AuthenticationSession.ts | 3 + src/api/types/OpenAiFunction.ts | 15 +- src/api/types/OpenAiFunctionParameters.ts | 3 + src/api/types/OpenAiMessage.ts | 5 + src/api/types/OpenAiMessageRole.ts | 1 + src/api/types/OpenAiModel.ts | 21 +- .../types/OpenAiModelFallbackModelsItem.ts | 38 + src/api/types/OpenAiModelModel.ts | 38 + .../types/OpenAiModelPromptCacheRetention.ts | 2 +- src/api/types/OpenAiModelReasoningEffort.ts | 17 + src/api/types/OpenAiModelToolsItem.ts | 25 + src/api/types/OpenAiTranscriber.ts | 3 + src/api/types/OpenAiVoice.ts | 3 + src/api/types/OpenAiVoicemailDetectionPlan.ts | 3 + src/api/types/OpenRouterModel.ts | 12 +- src/api/types/OpenRouterModelToolsItem.ts | 25 + src/api/types/Org.ts | 7 + src/api/types/OutputTool.ts | 7 +- src/api/types/PaginationMeta.ts | 20 + src/api/types/PaginationMetaSortOrder.ts | 7 + src/api/types/PendingInvitationDto.ts | 6 + .../types/PendingInvitationsResponseDto.ts | 7 + src/api/types/PerformanceMetrics.ts | 3 + src/api/types/PerplexityAiModel.ts | 12 +- src/api/types/PerplexityAiModelToolsItem.ts | 25 + .../types/PhoneNumberCallEndingHookFilter.ts | 3 + .../types/PhoneNumberCallRingingHookFilter.ts | 3 + src/api/types/PhoneNumberHookCallEnding.ts | 3 + src/api/types/PhoneNumberHookCallRinging.ts | 3 + src/api/types/PhoneNumberPaginatedResponse.ts | 3 + src/api/types/PieInsight.ts | 6 + src/api/types/PlayHtVoice.ts | 3 + .../types/PromptInjectionSecurityFilter.ts | 3 + src/api/types/ProviderResource.ts | 3 + .../ProviderResourcePaginatedResponse.ts | 5 + src/api/types/PublicKeyEncryptionPlan.ts | 3 + src/api/types/QueryTool.ts | 10 +- src/api/types/RceSecurityFilter.ts | 3 + src/api/types/Recording.ts | 3 + src/api/types/RecordingConsent.ts | 7 +- .../types/RecordingConsentPlanStayOnLine.ts | 17 + ...ngConsentPlanStayOnLineFirstMessageMode.ts | 21 + .../RecordingConsentPlanStayOnLineVoice.ts | 12 +- src/api/types/RecordingConsentPlanVerbal.ts | 17 + ...ordingConsentPlanVerbalFirstMessageMode.ts | 21 + .../types/RecordingConsentPlanVerbalVoice.ts | 12 +- src/api/types/RecordingConsentType.ts | 8 + src/api/types/RegexCondition.ts | 3 + src/api/types/RegexOption.ts | 3 + src/api/types/RegexReplacement.ts | 3 + src/api/types/RegexSecurityFilter.ts | 3 + src/api/types/RevokeInvitationResponseDto.ts | 5 + src/api/types/RimeAiVoice.ts | 3 + src/api/types/S3CompatibleBucketPlan.ts | 16 + .../types/S3CompatibleStorageCredential.ts | 21 + .../S3CompatibleStorageCredentialProvider.ts | 8 + src/api/types/SayHookAction.ts | 7 +- src/api/types/SayHookActionExact.ts | 6 + src/api/types/SayPhoneNumberHookAction.ts | 3 + src/api/types/SbcConfiguration.ts | 5 +- src/api/types/ScenarioToolMock.ts | 6 +- src/api/types/SchedulePlan.ts | 3 + src/api/types/Scorecard.ts | 3 + src/api/types/ScorecardMetric.ts | 17 +- .../types/ScorecardMetricConditionsItem.ts | 7 + src/api/types/ScorecardPaginatedResponse.ts | 5 + src/api/types/SecurityFilterBase.ts | 3 + src/api/types/SecurityFilterPlan.ts | 3 + src/api/types/Server.ts | 3 + .../types/ServerMessageAssistantRequest.ts | 7 + src/api/types/ServerMessageAssistantSpeech.ts | 7 + .../types/ServerMessageCallArtifactUpload.ts | 44 + ...verMessageCallArtifactUploadPhoneNumber.ts | 35 + .../ServerMessageCallArtifactUploadType.ts | 11 + .../types/ServerMessageCallDeleteFailed.ts | 7 + src/api/types/ServerMessageCallDeleted.ts | 7 + .../ServerMessageCallEndpointingRequest.ts | 7 + src/api/types/ServerMessageCampaignPredial.ts | 37 + ...ServerMessageCampaignPredialPhoneNumber.ts | 35 + .../types/ServerMessageCampaignPredialType.ts | 8 + src/api/types/ServerMessageChatCreated.ts | 7 + src/api/types/ServerMessageChatDeleted.ts | 7 + .../types/ServerMessageConversationUpdate.ts | 7 + src/api/types/ServerMessageEndOfCallReport.ts | 7 + ...ServerMessageEndOfCallReportEndedReason.ts | 30 + .../ServerMessageHandoffDestinationRequest.ts | 7 + src/api/types/ServerMessageHang.ts | 7 + .../ServerMessageKnowledgeBaseRequest.ts | 7 + .../ServerMessageLanguageChangeDetected.ts | 7 + src/api/types/ServerMessageMessage.ts | 4 +- src/api/types/ServerMessageModelOutput.ts | 7 + .../types/ServerMessagePhoneCallControl.ts | 7 + .../ServerMessageResponseCampaignPredial.ts | 6 + .../ServerMessageResponseMessageResponse.ts | 3 +- src/api/types/ServerMessageSessionCreated.ts | 7 + src/api/types/ServerMessageSessionDeleted.ts | 7 + src/api/types/ServerMessageSessionUpdated.ts | 7 + src/api/types/ServerMessageSpeechUpdate.ts | 7 + src/api/types/ServerMessageStatusUpdate.ts | 7 + .../ServerMessageStatusUpdateEndedReason.ts | 30 + src/api/types/ServerMessageToolCalls.ts | 7 + src/api/types/ServerMessageTranscript.ts | 17 + ...ServerMessageTransferDestinationRequest.ts | 7 + src/api/types/ServerMessageTransferUpdate.ts | 7 + src/api/types/ServerMessageUserInterrupted.ts | 7 + src/api/types/ServerMessageVoiceInput.ts | 7 + src/api/types/ServerMessageVoiceRequest.ts | 7 + src/api/types/SesameVoice.ts | 3 + src/api/types/SimulationRun.ts | 14 +- src/api/types/SimulationRunItem.ts | 16 +- src/api/types/SimulationRunItemCounts.ts | 16 +- src/api/types/SimulationRunItemStatus.ts | 2 +- src/api/types/SimulationRunListItem.ts | 35 + .../SimulationRunListItemSimulationsItem.ts | 24 + src/api/types/SimulationRunListItemStatus.ts | 10 + src/api/types/SimulationRunListItemTarget.ts | 25 + src/api/types/SimulationRunListSource.ts | 11 + src/api/types/SimulationRunListSourceType.ts | 10 + src/api/types/SimulationRunListSummary.ts | 9 + .../SimulationRunPaymentRequiredResponse.ts | 9 + ...ulationRunPaymentRequiredResponseReason.ts | 12 + src/api/types/SimulationRunSimulationsItem.ts | 7 + src/api/types/SimulationRunStatus.ts | 2 +- src/api/types/SimulationRunSuiteEntry.ts | 2 + src/api/types/SimulationRunTarget.ts | 7 +- .../types/SimulationRunsPaginatedResponse.ts | 8 + src/api/types/SimulationSuite.ts | 4 + .../types/SimulationSuiteTargetAssignment.ts | 10 + ...mulationSuiteTargetAssignmentTargetType.ts | 9 + src/api/types/SipAuthentication.ts | 5 +- src/api/types/SipRequestTool.ts | 10 +- src/api/types/SipTrunkGateway.ts | 5 +- .../SipTrunkOutboundAuthenticationPlan.ts | 4 + .../types/SipTrunkOutboundSipRegisterPlan.ts | 6 + src/api/types/SkippedStructuredOutput.ts | 13 + .../SkippedStructuredOutputUnmetCondition.ts | 26 + src/api/types/SlackSendMessageTool.ts | 10 +- src/api/types/SmallestAiVoice.ts | 3 + src/api/types/SmartDenoisingPlan.ts | 3 + src/api/types/SmsTool.ts | 10 +- src/api/types/SonioxContextGeneralItem.ts | 8 + src/api/types/SonioxCredential.ts | 2 + src/api/types/SonioxTranscriber.ts | 11 +- src/api/types/SonioxTranscriberLanguage.ts | 2 +- .../types/SonioxTranscriberLanguagesItem.ts | 191 + src/api/types/SonioxTranscriberModel.ts | 1 + .../types/SpeechmaticsCustomVocabularyItem.ts | 3 + src/api/types/SpeechmaticsTranscriber.ts | 5 + .../types/SpeechmaticsTranscriberLanguage.ts | 1 + src/api/types/SpkiPemPublicKeyConfig.ts | 3 + src/api/types/SqlInjectionSecurityFilter.ts | 3 + src/api/types/Squad.ts | 3 + src/api/types/SquadMemberDto.ts | 10 + src/api/types/SsrfSecurityFilter.ts | 3 + src/api/types/StartSpeakingPlan.ts | 3 + src/api/types/StopSpeakingPlan.ts | 3 + src/api/types/StructuredDataMultiPlan.ts | 3 + src/api/types/StructuredDataPlan.ts | 3 + src/api/types/StructuredOutput.ts | 5 + .../types/StructuredOutputConditionsItem.ts | 22 + .../types/StructuredOutputCostBreakdown.ts | 16 + .../types/StructuredOutputEvaluationResult.ts | 6 + .../StructuredOutputPaginatedResponse.ts | 5 + .../types/StructuredOutputRerunResponse.ts | 7 + .../StructuredOutputRunPreviewResponse.ts | 12 + src/api/types/StructuredOutputRunResult.ts | 11 + .../types/StructuredOutputRunResultResult.ts | 6 + src/api/types/Subscription.ts | 4 +- src/api/types/SubscriptionLimits.ts | 3 + src/api/types/SuccessEvaluationPlan.ts | 3 + src/api/types/SummaryPlan.ts | 3 + src/api/types/SupabaseBucketPlan.ts | 3 + .../types/SyncVoiceLibraryDtoProvidersItem.ts | 2 + src/api/types/SystemMessage.ts | 3 + src/api/types/TalkscriberTranscriber.ts | 3 + src/api/types/TavusConversationProperties.ts | 3 + src/api/types/TavusVoice.ts | 3 + src/api/types/TelnyxPhoneNumber.ts | 3 + src/api/types/TelnyxTransport.ts | 14 + .../types/TelnyxTransportConversationType.ts | 8 + src/api/types/TemplateDetails.ts | 25 + src/api/types/TextContent.ts | 6 + src/api/types/TextContentLanguage.ts | 1 + src/api/types/TextContentType.ts | 1 + src/api/types/TextEditorTool.ts | 10 +- src/api/types/TextEditorToolWithToolCall.ts | 6 +- src/api/types/TextInsight.ts | 6 + src/api/types/TimeRange.ts | 3 + src/api/types/TogetherAiModel.ts | 12 +- src/api/types/TogetherAiModelToolsItem.ts | 25 + src/api/types/ToolCall.ts | 3 + src/api/types/ToolCallFunction.ts | 3 + src/api/types/ToolCallHookAction.ts | 3 + src/api/types/ToolCallHookActionTool.ts | 28 + src/api/types/ToolCallMessage.ts | 3 + src/api/types/ToolCallResultMessage.ts | 36 +- src/api/types/ToolCallResultMessageWarning.ts | 17 + .../types/ToolCallResultMessageWarningType.ts | 13 + src/api/types/ToolDraft.ts | 179 + src/api/types/ToolDraftConflictResponseDto.ts | 7 + src/api/types/ToolDraftMessagesItem.ts | 27 + src/api/types/ToolDraftMethod.ts | 11 + src/api/types/ToolDraftPaginatedMetadata.ts | 7 + src/api/types/ToolDraftPaginatedResponse.ts | 8 + src/api/types/ToolDraftType.ts | 35 + src/api/types/ToolDraftVerb.ts | 9 + src/api/types/ToolMessage.ts | 3 + src/api/types/ToolMessageComplete.ts | 3 + src/api/types/ToolMessageDelayed.ts | 5 +- src/api/types/ToolMessageFailed.ts | 21 + src/api/types/ToolMessageFailedRole.ts | 22 + src/api/types/ToolMessageStart.ts | 3 + src/api/types/ToolNode.ts | 4 + src/api/types/ToolNodeTool.ts | 28 + src/api/types/ToolParameter.ts | 3 + .../types/ToolPinnedConflictResponseDto.ts | 9 + .../ToolPinnedConflictResponseDtoError.ts | 7 + src/api/types/ToolRef.ts | 8 + src/api/types/ToolRejectionPlan.ts | 3 + src/api/types/ToolVersion.ts | 65 + src/api/types/ToolVersionPaginatedMetadata.ts | 7 + src/api/types/ToolVersionPaginatedResponse.ts | 8 + src/api/types/TranscriberCost.ts | 3 + src/api/types/TranscriptPlan.ts | 3 + src/api/types/TranscriptionEndpointingPlan.ts | 3 + src/api/types/TransferArtifact.ts | 19 + src/api/types/TransferArtifactDestination.ts | 20 + src/api/types/TransferArtifactMessagesItem.ts | 10 + src/api/types/TransferArtifactMode.ts | 16 + src/api/types/TransferArtifactStatus.ts | 13 + src/api/types/TransferAssistantTranscriber.ts | 12 +- src/api/types/TransferAssistantVoice.ts | 12 +- src/api/types/TransferCallTool.ts | 10 +- .../types/TransferCancelToolUserEditable.ts | 6 +- src/api/types/TransferDestinationAssistant.ts | 4 + .../types/TransferDestinationAssistantType.ts | 1 + src/api/types/TransferDestinationNumber.ts | 3 + src/api/types/TransferDestinationSip.ts | 3 + src/api/types/TransferFallbackPlan.ts | 3 + .../types/TransferPhoneNumberHookAction.ts | 3 + src/api/types/TransferPlan.ts | 9 +- .../TransferSuccessfulToolUserEditable.ts | 6 +- src/api/types/TransportConfigurationTwilio.ts | 4 + .../TransportConfigurationTwilioProvider.ts | 1 + src/api/types/TransportCost.ts | 4 + src/api/types/TransportCostProvider.ts | 1 + src/api/types/TrieveCredentialProvider.ts | 6 - src/api/types/TrieveKnowledgeBase.ts | 27 +- src/api/types/TrieveKnowledgeBaseChunkPlan.ts | 14 - src/api/types/TrieveKnowledgeBaseCreate.ts | 10 - .../types/TrieveKnowledgeBaseCreateType.ts | 8 - src/api/types/TrieveKnowledgeBaseImport.ts | 9 +- .../types/TrieveKnowledgeBaseImportType.ts | 8 - src/api/types/TrieveKnowledgeBaseProvider.ts | 12 - .../types/TrieveKnowledgeBaseSearchPlan.ts | 14 - ...TrieveKnowledgeBaseSearchPlanSearchType.ts | 11 - src/api/types/TurnLatency.ts | 3 + src/api/types/TwilioPhoneNumber.ts | 3 + src/api/types/TwilioTransport.ts | 19 + .../types/TwilioTransportConversationType.ts | 8 + src/api/types/TwilioVoicemailDetectionPlan.ts | 3 + .../UpdateAnthropicBedrockCredentialDto.ts | 1 + ...teAnthropicBedrockCredentialDtoProvider.ts | 7 + ...dateAnthropicBedrockCredentialDtoRegion.ts | 1 + src/api/types/UpdateAnthropicCredentialDto.ts | 3 + .../UpdateAnthropicCredentialDtoProvider.ts | 7 + src/api/types/UpdateAnyscaleCredentialDto.ts | 3 + .../UpdateAnyscaleCredentialDtoProvider.ts | 7 + src/api/types/UpdateApiRequestToolDto.ts | 18 +- .../types/UpdateApiRequestToolDtoMethod.ts | 1 + .../types/UpdateAssemblyAiCredentialDto.ts | 3 + .../UpdateAssemblyAiCredentialDtoProvider.ts | 7 + src/api/types/UpdateAssistantDraftDto.ts | 151 + .../UpdateAssistantDraftDtoBackgroundSound.ts | 9 + ...ateAssistantDraftDtoBackgroundSoundZero.ts | 8 + ...dateAssistantDraftDtoClientMessagesItem.ts | 25 + .../UpdateAssistantDraftDtoCredentialsItem.ts | 352 + ...UpdateAssistantDraftDtoFirstMessageMode.ts | 19 + .../types/UpdateAssistantDraftDtoHooksItem.ts | 10 + src/api/types/UpdateAssistantDraftDtoModel.ts | 117 + ...dateAssistantDraftDtoServerMessagesItem.ts | 34 + .../UpdateAssistantDraftDtoTranscriber.ts | 80 + src/api/types/UpdateAssistantDraftDtoVoice.ts | 110 + ...dateAssistantDraftDtoVoicemailDetection.ts | 14 + ...AssistantDraftDtoVoicemailDetectionZero.ts | 7 + .../UpdateAssistantVersionMetadataDto.ts | 8 + src/api/types/UpdateAzureCredentialDto.ts | 1 + .../types/UpdateAzureCredentialDtoProvider.ts | 7 + .../types/UpdateAzureCredentialDtoRegion.ts | 2 + .../types/UpdateAzureOpenAiCredentialDto.ts | 1 + ...pdateAzureOpenAiCredentialDtoModelsItem.ts | 6 + .../UpdateAzureOpenAiCredentialDtoProvider.ts | 7 + .../UpdateAzureOpenAiCredentialDtoRegion.ts | 2 + .../types/UpdateBarInsightFromCallTableDto.ts | 4 + src/api/types/UpdateBashToolDto.ts | 9 +- src/api/types/UpdateByoPhoneNumberDto.ts | 3 + .../types/UpdateByoSipTrunkCredentialDto.ts | 4 +- .../UpdateByoSipTrunkCredentialDtoProvider.ts | 8 + .../requests => types}/UpdateCampaignDto.ts | 29 +- .../types/UpdateCampaignDtoStatus.ts | 6 +- src/api/types/UpdateCartesiaCredentialDto.ts | 5 + .../UpdateCartesiaCredentialDtoProvider.ts | 7 + src/api/types/UpdateCerebrasCredentialDto.ts | 3 + .../UpdateCerebrasCredentialDtoProvider.ts | 7 + .../types/UpdateCloudflareCredentialDto.ts | 2 + .../UpdateCloudflareCredentialDtoProvider.ts | 8 + src/api/types/UpdateCodeToolDto.ts | 8 +- src/api/types/UpdateCodeToolDtoType.ts | 7 + src/api/types/UpdateComputerToolDto.ts | 9 +- src/api/types/UpdateCustomCredentialDto.ts | 1 + .../UpdateCustomCredentialDtoProvider.ts | 7 + src/api/types/UpdateCustomKnowledgeBaseDto.ts | 2 + .../UpdateCustomKnowledgeBaseDtoProvider.ts | 8 + src/api/types/UpdateCustomLlmCredentialDto.ts | 1 + .../UpdateCustomLlmCredentialDtoProvider.ts | 7 + src/api/types/UpdateDeepInfraCredentialDto.ts | 3 + .../UpdateDeepInfraCredentialDtoProvider.ts | 7 + src/api/types/UpdateDeepSeekCredentialDto.ts | 3 + .../UpdateDeepSeekCredentialDtoProvider.ts | 7 + src/api/types/UpdateDeepgramCredentialDto.ts | 3 + .../UpdateDeepgramCredentialDtoProvider.ts | 7 + src/api/types/UpdateDtmfToolDto.ts | 9 +- .../types/UpdateElevenLabsCredentialDto.ts | 6 +- .../UpdateElevenLabsCredentialDtoApiUrl.ts | 9 + src/api/types/UpdateEmailCredentialDto.ts | 3 + .../types/UpdateEmailCredentialDtoProvider.ts | 7 + src/api/types/UpdateEndCallToolDto.ts | 9 +- src/api/types/UpdateFunctionToolDto.ts | 9 +- src/api/types/UpdateGcpCredentialDto.ts | 1 + .../types/UpdateGcpCredentialDtoProvider.ts | 7 + src/api/types/UpdateGhlToolDto.ts | 8 +- src/api/types/UpdateGhlToolDtoType.ts | 7 + src/api/types/UpdateGladiaCredentialDto.ts | 3 + .../UpdateGladiaCredentialDtoProvider.ts | 7 + ...eGoHighLevelCalendarAvailabilityToolDto.ts | 9 +- ...teGoHighLevelCalendarEventCreateToolDto.ts | 9 +- .../UpdateGoHighLevelContactCreateToolDto.ts | 9 +- .../UpdateGoHighLevelContactGetToolDto.ts | 9 +- .../types/UpdateGoHighLevelCredentialDto.ts | 3 + .../UpdateGoHighLevelCredentialDtoProvider.ts | 7 + .../UpdateGoHighLevelMcpCredentialDto.ts | 1 + ...dateGoHighLevelMcpCredentialDtoProvider.ts | 7 + ...eGoogleCalendarCheckAvailabilityToolDto.ts | 9 +- .../UpdateGoogleCalendarCreateEventToolDto.ts | 9 +- ...alendarOAuth2AuthorizationCredentialDto.ts | 3 + ...Auth2AuthorizationCredentialDtoProvider.ts | 7 + ...GoogleCalendarOAuth2ClientCredentialDto.ts | 3 + ...lendarOAuth2ClientCredentialDtoProvider.ts | 7 + src/api/types/UpdateGoogleCredentialDto.ts | 4 + .../UpdateGoogleCredentialDtoProvider.ts | 8 + ...eSheetsOAuth2AuthorizationCredentialDto.ts | 3 + ...Auth2AuthorizationCredentialDtoProvider.ts | 7 + .../UpdateGoogleSheetsRowAppendToolDto.ts | 9 +- src/api/types/UpdateGroqCredentialDto.ts | 3 + .../types/UpdateGroqCredentialDtoProvider.ts | 7 + src/api/types/UpdateHandoffToolDto.ts | 9 +- .../UpdateHandoffToolDtoDestinationsItem.ts | 5 + src/api/types/UpdateHumeCredentialDto.ts | 3 + .../types/UpdateHumeCredentialDtoProvider.ts | 7 + .../types/UpdateInflectionAiCredentialDto.ts | 4 + ...UpdateInflectionAiCredentialDtoProvider.ts | 8 + src/api/types/UpdateInworldCredentialDto.ts | 3 + .../UpdateInworldCredentialDtoProvider.ts | 7 + src/api/types/UpdateKnowledgeBaseToolDto.ts | 92 + .../UpdateKnowledgeBaseToolDtoMessagesItem.ts | 27 + src/api/types/UpdateLangfuseCredentialDto.ts | 3 + .../UpdateLangfuseCredentialDtoProvider.ts | 7 + .../UpdateLineInsightFromCallTableDto.ts | 4 + src/api/types/UpdateLmntCredentialDto.ts | 3 + .../types/UpdateLmntCredentialDtoProvider.ts | 7 + src/api/types/UpdateMakeCredentialDto.ts | 3 + .../types/UpdateMakeCredentialDtoProvider.ts | 7 + src/api/types/UpdateMakeToolDto.ts | 8 +- src/api/types/UpdateMakeToolDtoType.ts | 7 + src/api/types/UpdateMcpToolDto.ts | 10 +- src/api/types/UpdateMicrosoftCredentialDto.ts | 13 + .../UpdateMicrosoftCredentialDtoProvider.ts | 7 + src/api/types/UpdateMistralCredentialDto.ts | 3 + .../UpdateMistralCredentialDtoProvider.ts | 7 + src/api/types/UpdateNeuphonicCredentialDto.ts | 3 + .../UpdateNeuphonicCredentialDtoProvider.ts | 7 + src/api/types/UpdateOpenAiCredentialDto.ts | 3 + .../UpdateOpenAiCredentialDtoProvider.ts | 7 + .../types/UpdateOpenRouterCredentialDto.ts | 3 + .../UpdateOpenRouterCredentialDtoProvider.ts | 7 + src/api/types/UpdateOutputToolDto.ts | 8 +- src/api/types/UpdateOutputToolDtoType.ts | 7 + .../types/UpdatePerplexityAiCredentialDto.ts | 3 + ...UpdatePerplexityAiCredentialDtoProvider.ts | 7 + .../types/UpdatePieInsightFromCallTableDto.ts | 4 + src/api/types/UpdatePlayHtCredentialDto.ts | 3 + .../UpdatePlayHtCredentialDtoProvider.ts | 7 + src/api/types/UpdateQueryToolDto.ts | 9 +- src/api/types/UpdateRimeAiCredentialDto.ts | 3 + .../UpdateRimeAiCredentialDtoProvider.ts | 7 + src/api/types/UpdateRunpodCredentialDto.ts | 3 + .../UpdateRunpodCredentialDtoProvider.ts | 7 + .../types/UpdateS3CompatibleBucketPlanDto.ts | 16 + .../types/UpdateS3CompatibleCredentialDto.ts | 13 + ...UpdateS3CompatibleCredentialDtoProvider.ts | 8 + src/api/types/UpdateS3CredentialDto.ts | 4 + .../types/UpdateS3CredentialDtoProvider.ts | 8 + src/api/types/UpdateSipRequestToolDto.ts | 9 +- ...teSlackOAuth2AuthorizationCredentialDto.ts | 3 + ...Auth2AuthorizationCredentialDtoProvider.ts | 7 + .../types/UpdateSlackSendMessageToolDto.ts | 9 +- .../types/UpdateSlackWebhookCredentialDto.ts | 3 + ...UpdateSlackWebhookCredentialDtoProvider.ts | 7 + src/api/types/UpdateSmsToolDto.ts | 9 +- src/api/types/UpdateSonioxCredentialDto.ts | 5 + .../UpdateSonioxCredentialDtoProvider.ts | 7 + src/api/types/UpdateTelnyxPhoneNumberDto.ts | 3 + src/api/types/UpdateTextEditorToolDto.ts | 9 +- .../UpdateTextInsightFromCallTableDto.ts | 4 + .../types/UpdateTogetherAiCredentialDto.ts | 3 + .../UpdateTogetherAiCredentialDtoProvider.ts | 7 + src/api/types/UpdateToolDraftDto.ts | 156 + .../types/UpdateToolDraftDtoMessagesItem.ts | 27 + src/api/types/UpdateToolDraftDtoMethod.ts | 11 + src/api/types/UpdateToolDraftDtoType.ts | 35 + src/api/types/UpdateToolDraftDtoVerb.ts | 9 + src/api/types/UpdateToolTemplateDtoDetails.ts | 25 + src/api/types/UpdateToolVersionMetadataDto.ts | 8 + src/api/types/UpdateTransferCallToolDto.ts | 9 +- src/api/types/UpdateTrieveCredentialDto.ts | 8 - src/api/types/UpdateTrieveKnowledgeBaseDto.ts | 17 +- src/api/types/UpdateTwilioCredentialDto.ts | 3 + .../UpdateTwilioCredentialDtoProvider.ts | 7 + src/api/types/UpdateTwilioPhoneNumberDto.ts | 3 + src/api/types/UpdateUserRoleDtoRole.ts | 9 +- src/api/types/UpdateUserRoleDtoRoleZero.ts | 8 + src/api/types/UpdateVapiPhoneNumberDto.ts | 3 + .../types/UpdateVoiceLibraryMetadataDto.ts | 8 + src/api/types/UpdateVoicemailToolDto.ts | 9 +- src/api/types/UpdateVonageCredentialDto.ts | 3 + .../UpdateVonageCredentialDtoProvider.ts | 7 + src/api/types/UpdateVonagePhoneNumberDto.ts | 3 + src/api/types/UpdateWebhookCredentialDto.ts | 1 + .../UpdateWebhookCredentialDtoProvider.ts | 7 + src/api/types/UpdateWellSaidCredentialDto.ts | 3 + .../UpdateWellSaidCredentialDtoProvider.ts | 7 + .../types/UpdateWorkflowDtoCredentialsItem.ts | 74 +- src/api/types/UpdateWorkflowDtoNodesItem.ts | 2 + src/api/types/UpdateWorkflowDtoTranscriber.ts | 12 +- src/api/types/UpdateWorkflowDtoVoice.ts | 12 +- src/api/types/UpdateXAiCredentialDto.ts | 4 + .../types/UpdateXAiCredentialDtoProvider.ts | 8 + src/api/types/UserMessage.ts | 3 + src/api/types/VapiCost.ts | 3 + src/api/types/VapiModel.ts | 30 +- src/api/types/VapiModelProvider.ts | 6 - src/api/types/VapiModelToolsItem.ts | 25 + src/api/types/VapiModelVersion.ts | 12 + src/api/types/VapiPhoneNumber.ts | 3 + .../VapiPronunciationDictionaryLocator.ts | 9 +- ...iPronunciationDictionaryLocatorProvider.ts | 9 + src/api/types/VapiSipTransport.ts | 18 + .../types/VapiSipTransportConversationType.ts | 8 + src/api/types/VapiSmartEndpointingPlan.ts | 3 + src/api/types/VapiTranscriber.ts | 39 + src/api/types/VapiTranscriberLanguage.ts | 196 + src/api/types/VapiTranscriberLanguagesItem.ts | 191 + src/api/types/VapiTranscriberTurnTaking.ts | 12 + src/api/types/VapiTranscriberVersion.ts | 14 + src/api/types/VapiVoice.ts | 13 +- src/api/types/VapiVoiceCloneDto.ts | 13 + src/api/types/VapiVoiceLanguage.ts | 63 + src/api/types/VapiVoiceVersion.ts | 9 + src/api/types/VapiVoiceVoiceId.ts | 36 - src/api/types/VapiVoicemailDetectionPlan.ts | 3 + src/api/types/VapiWebCallTransport.ts | 20 + .../VapiWebCallTransportConversationType.ts | 8 + src/api/types/VapiWebsocketTransport.ts | 10 + .../VapiWebsocketTransportConversationType.ts | 8 + src/api/types/VariableExtractionAlias.ts | 3 + src/api/types/VariableExtractionPlan.ts | 3 + src/api/types/VariableValueGroupBy.ts | 3 + .../types/VersionPinConflictResponseDto.ts | 11 + .../VersionPinConflictResponseDtoError.ts | 7 + src/api/types/VersionPinReference.ts | 10 + .../types/VersionPinReferenceSourceType.ts | 10 + src/api/types/VoiceCost.ts | 3 + src/api/types/VoiceLibrary.ts | 11 + src/api/types/VoiceLibraryVoiceResponse.ts | 4 +- src/api/types/VoiceLibraryVoiceResponseAge.ts | 3 + .../types/VoicemailDetectionBackoffPlan.ts | 3 + src/api/types/VoicemailDetectionCost.ts | 3 + src/api/types/VoicemailTool.ts | 10 +- src/api/types/VonagePhoneNumber.ts | 3 + src/api/types/VonageTransport.ts | 12 + .../types/VonageTransportConversationType.ts | 8 + src/api/types/WellSaidVoice.ts | 3 + .../types/WorkflowAnthropicBedrockModel.ts | 16 + .../WorkflowAnthropicBedrockModelModel.ts | 1 + src/api/types/WorkflowAnthropicModel.ts | 16 + src/api/types/WorkflowAnthropicModelModel.ts | 1 + src/api/types/WorkflowCredentialsItem.ts | 74 +- src/api/types/WorkflowCustomModel.ts | 16 + src/api/types/WorkflowGoogleModel.ts | 16 + src/api/types/WorkflowGoogleModelModel.ts | 2 + src/api/types/WorkflowNodesItem.ts | 2 + src/api/types/WorkflowOpenAiModel.ts | 16 + src/api/types/WorkflowOpenAiModelModel.ts | 37 + src/api/types/WorkflowOverrides.ts | 3 + src/api/types/WorkflowTranscriber.ts | 12 +- .../WorkflowUserEditableCredentialsItem.ts | 74 +- .../types/WorkflowUserEditableNodesItem.ts | 2 + .../types/WorkflowUserEditableTranscriber.ts | 12 +- src/api/types/WorkflowUserEditableVoice.ts | 12 +- src/api/types/WorkflowVoice.ts | 12 +- src/api/types/XaiModel.ts | 12 +- src/api/types/XaiModelModel.ts | 3 + src/api/types/XaiModelToolsItem.ts | 25 + src/api/types/XaiTranscriber.ts | 12 + src/api/types/XaiTranscriberLanguage.ts | 31 + src/api/types/XaiTranscriberModel.ts | 7 + src/api/types/XaiVoice.ts | 18 + src/api/types/XaiVoiceLanguage.ts | 27 + src/api/types/XaiVoiceVoiceId.ts | 11 + src/api/types/XssSecurityFilter.ts | 3 + src/api/types/index.ts | 356 +- src/version.ts | 2 +- tests/wire/assistants.test.ts | 297 +- tests/wire/board.test.ts | 467 + tests/wire/calls.test.ts | 55138 +++++----------- tests/wire/campaigns.test.ts | 26128 +++++--- tests/wire/chats.test.ts | 480 +- tests/wire/eval.test.ts | 100 + tests/wire/files.test.ts | 4 +- tests/wire/insight.test.ts | 18 + tests/wire/knowledgeBasesV2.test.ts | 370 + tests/wire/observabilityScorecard.test.ts | 92 +- tests/wire/phoneNumbers.test.ts | 8 + tests/wire/providerResources.test.ts | 8 + tests/wire/sessions.test.ts | 38936 ++++++----- tests/wire/simulationPersonalities.test.ts | 5097 ++ tests/wire/simulationRuns.test.ts | 12303 ++++ tests/wire/simulationScenarios.test.ts | 6096 ++ tests/wire/simulationSuites.test.ts | 236 + tests/wire/simulations.test.ts | 261 + tests/wire/squads.test.ts | 342 +- tests/wire/structuredOutputs.test.ts | 203 +- tests/wire/tools.test.ts | 48 +- 1417 files changed, 108172 insertions(+), 65433 deletions(-) create mode 100644 .fern/replay.lock create mode 100644 .gitattributes create mode 100644 src/api/errors/ConflictError.ts create mode 100644 src/api/errors/InternalServerError.ts create mode 100644 src/api/errors/PaymentRequiredError.ts create mode 100644 src/api/errors/ServiceUnavailableError.ts create mode 100644 src/api/errors/UnauthorizedError.ts create mode 100644 src/api/resources/board/client/Client.ts create mode 100644 src/api/resources/board/client/index.ts create mode 100644 src/api/resources/board/client/requests/BoardControllerFindAllRequest.ts create mode 100644 src/api/resources/board/client/requests/BoardControllerFindOneRequest.ts create mode 100644 src/api/resources/board/client/requests/BoardControllerRemoveRequest.ts create mode 100644 src/api/resources/board/client/requests/CreateBoardDto.ts create mode 100644 src/api/resources/board/client/requests/UpdateBoardDto.ts create mode 100644 src/api/resources/board/client/requests/index.ts create mode 100644 src/api/resources/board/exports.ts create mode 100644 src/api/resources/board/index.ts create mode 100644 src/api/resources/board/types/BoardControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/board/types/BoardControllerFindAllRequestSortOrder.ts create mode 100644 src/api/resources/board/types/CreateBoardDtoItemsItem.ts create mode 100644 src/api/resources/board/types/UpdateBoardDtoItemsItem.ts create mode 100644 src/api/resources/board/types/index.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerAssistantRecordingDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerCallLogsDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerCustomerRecordingDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerMonoRecordingDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerPcapDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerStereoRecordingDownloadRequest.ts create mode 100644 src/api/resources/calls/client/requests/CallArtifactControllerVideoRecordingDownloadRequest.ts create mode 100644 src/api/resources/calls/types/CreateCallDtoTransport.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerFindAllV2Request.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerFindOneV2Request.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerGetCampaignV2ContactsRequest.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerRemoveV2Request.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerUpdateRequest.ts create mode 100644 src/api/resources/campaigns/client/requests/CampaignControllerUpdateV2Request.ts delete mode 100644 src/api/resources/campaigns/client/requests/CreateCampaignDto.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortBy.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortOrder.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestStatus.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestSortBy.ts create mode 100644 src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestStatusItem.ts create mode 100644 src/api/resources/chats/types/ListChatsRequestSortBy.ts create mode 100644 src/api/resources/eval/types/EvalControllerGetPaginatedRequestSortBy.ts create mode 100644 src/api/resources/eval/types/EvalControllerGetRunsPaginatedRequestSortBy.ts create mode 100644 src/api/resources/files/client/requests/ListFilesRequest.ts create mode 100644 src/api/resources/files/types/CreateFilesRequestPurpose.ts create mode 100644 src/api/resources/files/types/index.ts create mode 100644 src/api/resources/insight/types/InsightControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/Client.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/index.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/AttachKnowledgeBaseV2FileDto.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/CreateKnowledgeBaseV2Dto.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileDetachRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileRetryRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFilesGetRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindAllRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindOneRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerRemoveRequest.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/UpdateKnowledgeBaseV2Dto.ts create mode 100644 src/api/resources/knowledgeBasesV2/client/requests/index.ts create mode 100644 src/api/resources/knowledgeBasesV2/exports.ts create mode 100644 src/api/resources/knowledgeBasesV2/index.ts create mode 100644 src/api/resources/observabilityScorecard/types/ScorecardControllerGetPaginatedRequestSortBy.ts create mode 100644 src/api/resources/phoneNumbers/types/PhoneNumberControllerFindAllPaginatedRequestSortBy.ts create mode 100644 src/api/resources/providerResources/types/ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy.ts create mode 100644 src/api/resources/sessions/types/ListSessionsRequestSortBy.ts create mode 100644 src/api/resources/simulationPersonalities/client/Client.ts create mode 100644 src/api/resources/simulationPersonalities/client/index.ts create mode 100644 src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindAllRequest.ts create mode 100644 src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindOneRequest.ts create mode 100644 src/api/resources/simulationPersonalities/client/requests/PersonalityControllerRemoveRequest.ts rename src/api/{types => resources/simulationPersonalities/client/requests}/UpdatePersonalityDto.ts (60%) create mode 100644 src/api/resources/simulationPersonalities/client/requests/index.ts create mode 100644 src/api/resources/simulationPersonalities/exports.ts create mode 100644 src/api/resources/simulationPersonalities/index.ts create mode 100644 src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortOrder.ts create mode 100644 src/api/resources/simulationPersonalities/types/index.ts create mode 100644 src/api/resources/simulationRuns/client/Client.ts create mode 100644 src/api/resources/simulationRuns/client/index.ts rename src/api/{types => resources/simulationRuns/client/requests}/CreateSimulationRunDto.ts (57%) create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelGroupRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelItemRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindAllRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemsRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindOneRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/SimulationRunControllerGenerateSuggestionsRequest.ts create mode 100644 src/api/resources/simulationRuns/client/requests/index.ts create mode 100644 src/api/resources/simulationRuns/exports.ts create mode 100644 src/api/resources/simulationRuns/index.ts rename src/api/{ => resources/simulationRuns}/types/CreateSimulationRunDtoSimulationsItem.ts (58%) rename src/api/{ => resources/simulationRuns}/types/CreateSimulationRunDtoTarget.ts (70%) create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestFilterStatus.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortOrder.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestStatus.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestTargetType.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindAllResponse.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortBy.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortOrder.ts create mode 100644 src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestStatus.ts create mode 100644 src/api/resources/simulationRuns/types/index.ts create mode 100644 src/api/resources/simulationScenarios/client/Client.ts create mode 100644 src/api/resources/simulationScenarios/client/index.ts create mode 100644 src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindAllRequest.ts create mode 100644 src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindOneRequest.ts create mode 100644 src/api/resources/simulationScenarios/client/requests/ScenarioControllerRemoveRequest.ts rename src/api/{types => resources/simulationScenarios/client/requests}/UpdateScenarioDto.ts (63%) create mode 100644 src/api/resources/simulationScenarios/client/requests/index.ts create mode 100644 src/api/resources/simulationScenarios/exports.ts create mode 100644 src/api/resources/simulationScenarios/index.ts create mode 100644 src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortOrder.ts rename src/api/{ => resources/simulationScenarios}/types/UpdateScenarioDtoHooksItem.ts (91%) create mode 100644 src/api/resources/simulationScenarios/types/index.ts create mode 100644 src/api/resources/simulationSuites/client/Client.ts create mode 100644 src/api/resources/simulationSuites/client/index.ts create mode 100644 src/api/resources/simulationSuites/client/requests/CreateSimulationSuiteDto.ts create mode 100644 src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindAllRequest.ts create mode 100644 src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindOneRequest.ts create mode 100644 src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerRemoveRequest.ts rename src/api/{types => resources/simulationSuites/client/requests}/UpdateSimulationSuiteDto.ts (54%) create mode 100644 src/api/resources/simulationSuites/client/requests/index.ts create mode 100644 src/api/resources/simulationSuites/exports.ts create mode 100644 src/api/resources/simulationSuites/index.ts create mode 100644 src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortOrder.ts create mode 100644 src/api/resources/simulationSuites/types/index.ts create mode 100644 src/api/resources/simulations/client/Client.ts create mode 100644 src/api/resources/simulations/client/index.ts rename src/api/{types => resources/simulations/client/requests}/CreateSimulationDto.ts (52%) rename src/api/{types => resources/simulations/client/requests}/GenerateScenariosDto.ts (73%) create mode 100644 src/api/resources/simulations/client/requests/SimulationControllerFindAllRequest.ts create mode 100644 src/api/resources/simulations/client/requests/SimulationControllerFindOneRequest.ts create mode 100644 src/api/resources/simulations/client/requests/SimulationControllerRemoveRequest.ts rename src/api/{types => resources/simulations/client/requests}/UpdateSimulationDto.ts (68%) create mode 100644 src/api/resources/simulations/client/requests/index.ts create mode 100644 src/api/resources/simulations/exports.ts create mode 100644 src/api/resources/simulations/index.ts create mode 100644 src/api/resources/simulations/types/SimulationControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/simulations/types/SimulationControllerFindAllRequestSortOrder.ts create mode 100644 src/api/resources/simulations/types/index.ts create mode 100644 src/api/resources/structuredOutputs/types/StructuredOutputControllerFindAllRequestSortBy.ts create mode 100644 src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponse.ts create mode 100644 src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponseZero.ts create mode 100644 src/api/resources/structuredOutputs/types/UpdateStructuredOutputDtoConditionsItem.ts create mode 100644 src/api/types/AssemblyAiTranscriberLanguageCodesItem.ts create mode 100644 src/api/types/AssemblyAiTranscriberMode.ts create mode 100644 src/api/types/AssistantDraft.ts create mode 100644 src/api/types/AssistantDraftBackgroundSound.ts create mode 100644 src/api/types/AssistantDraftBackgroundSoundZero.ts create mode 100644 src/api/types/AssistantDraftClientMessagesItem.ts create mode 100644 src/api/types/AssistantDraftConflictResponseDto.ts create mode 100644 src/api/types/AssistantDraftCredentialsItem.ts create mode 100644 src/api/types/AssistantDraftFirstMessageMode.ts create mode 100644 src/api/types/AssistantDraftHooksItem.ts create mode 100644 src/api/types/AssistantDraftModel.ts create mode 100644 src/api/types/AssistantDraftPaginatedMetadata.ts create mode 100644 src/api/types/AssistantDraftPaginatedResponse.ts create mode 100644 src/api/types/AssistantDraftServerMessagesItem.ts create mode 100644 src/api/types/AssistantDraftTranscriber.ts create mode 100644 src/api/types/AssistantDraftVoice.ts create mode 100644 src/api/types/AssistantDraftVoicemailDetection.ts create mode 100644 src/api/types/AssistantDraftVoicemailDetectionZero.ts create mode 100644 src/api/types/AssistantPinnedConflictResponseDto.ts create mode 100644 src/api/types/AssistantPinnedConflictResponseDtoError.ts create mode 100644 src/api/types/AssistantVersion.ts create mode 100644 src/api/types/AssistantVersionBackgroundSound.ts create mode 100644 src/api/types/AssistantVersionBackgroundSoundZero.ts create mode 100644 src/api/types/AssistantVersionClientMessagesItem.ts create mode 100644 src/api/types/AssistantVersionCredentialsItem.ts create mode 100644 src/api/types/AssistantVersionFirstMessageMode.ts create mode 100644 src/api/types/AssistantVersionHooksItem.ts create mode 100644 src/api/types/AssistantVersionModel.ts create mode 100644 src/api/types/AssistantVersionPaginatedMetadata.ts create mode 100644 src/api/types/AssistantVersionServerMessagesItem.ts create mode 100644 src/api/types/AssistantVersionTranscriber.ts create mode 100644 src/api/types/AssistantVersionVoice.ts create mode 100644 src/api/types/AssistantVersionVoicemailDetection.ts create mode 100644 src/api/types/AssistantVersionVoicemailDetectionZero.ts create mode 100644 src/api/types/AudioFormat.ts create mode 100644 src/api/types/AudioFormatContainer.ts create mode 100644 src/api/types/Board.ts create mode 100644 src/api/types/BoardInsightItem.ts create mode 100644 src/api/types/BoardInsightItemType.ts create mode 100644 src/api/types/BoardItemPosition.ts create mode 100644 src/api/types/BoardItemSize.ts create mode 100644 src/api/types/BoardItemsItem.ts create mode 100644 src/api/types/BoardLayout.ts create mode 100644 src/api/types/BoardMetricWidgetItem.ts create mode 100644 src/api/types/BoardMetricWidgetItemType.ts create mode 100644 src/api/types/BoardPaginatedResponse.ts create mode 100644 src/api/types/BooleanComparatorScorecardMetricCondition.ts create mode 100644 src/api/types/BooleanComparatorScorecardMetricConditionComparator.ts create mode 100644 src/api/types/BooleanComparatorScorecardMetricConditionType.ts create mode 100644 src/api/types/CallArtifactUploadItem.ts create mode 100644 src/api/types/CallArtifactUploadItemType.ts create mode 100644 src/api/types/CallTransport.ts create mode 100644 src/api/types/CampaignCallMetrics.ts create mode 100644 src/api/types/CampaignContact.ts create mode 100644 src/api/types/CampaignContactCounters.ts create mode 100644 src/api/types/CampaignContactPaginatedResponse.ts create mode 100644 src/api/types/CampaignContactWithOutcome.ts create mode 100644 src/api/types/CampaignContactWithOutcomeStatus.ts create mode 100644 src/api/types/CampaignPredialPlan.ts create mode 100644 src/api/types/CampaignServerMessagesItem.ts create mode 100644 src/api/types/CampaignSummary.ts create mode 100644 src/api/types/CampaignSummaryEndedReason.ts create mode 100644 src/api/types/CampaignSummaryPaginatedResponse.ts create mode 100644 src/api/types/CampaignSummaryServerMessagesItem.ts create mode 100644 src/api/types/CampaignSummaryStatus.ts create mode 100644 src/api/types/ContextEngineeringPlanPreviousAssistantMessages.ts create mode 100644 src/api/types/CreateAssistantDraftDto.ts create mode 100644 src/api/types/CreateAssistantDraftDtoBackgroundSound.ts create mode 100644 src/api/types/CreateAssistantDraftDtoBackgroundSoundZero.ts create mode 100644 src/api/types/CreateAssistantDraftDtoClientMessagesItem.ts create mode 100644 src/api/types/CreateAssistantDraftDtoCredentialsItem.ts create mode 100644 src/api/types/CreateAssistantDraftDtoFirstMessageMode.ts create mode 100644 src/api/types/CreateAssistantDraftDtoHooksItem.ts create mode 100644 src/api/types/CreateAssistantDraftDtoModel.ts create mode 100644 src/api/types/CreateAssistantDraftDtoServerMessagesItem.ts create mode 100644 src/api/types/CreateAssistantDraftDtoTranscriber.ts create mode 100644 src/api/types/CreateAssistantDraftDtoVoice.ts create mode 100644 src/api/types/CreateAssistantDraftDtoVoicemailDetection.ts create mode 100644 src/api/types/CreateAssistantDraftDtoVoicemailDetectionZero.ts create mode 100644 src/api/types/CreateCampaignDto.ts create mode 100644 src/api/types/CreateCampaignDtoServerMessagesItem.ts create mode 100644 src/api/types/CreateElevenLabsCredentialDtoApiUrl.ts create mode 100644 src/api/types/CreateMicrosoftCredentialDto.ts create mode 100644 src/api/types/CreateOutboundCallDtoTransport.ts create mode 100644 src/api/types/CreateS3CompatibleCredentialDto.ts create mode 100644 src/api/types/CreateSimulationRunResponse.ts create mode 100644 src/api/types/CreateSimulationRunResponseSimulationsItem.ts create mode 100644 src/api/types/CreateSimulationRunResponseStatus.ts create mode 100644 src/api/types/CreateSimulationRunResponseTarget.ts delete mode 100644 src/api/types/CreateSimulationSuiteDto.ts create mode 100644 src/api/types/CreateStructuredOutputDtoConditionsItem.ts create mode 100644 src/api/types/CreateToolDraftDto.ts create mode 100644 src/api/types/CreateToolDraftDtoMessagesItem.ts create mode 100644 src/api/types/CreateToolDraftDtoMethod.ts create mode 100644 src/api/types/CreateToolDraftDtoType.ts create mode 100644 src/api/types/CreateToolDraftDtoVerb.ts delete mode 100644 src/api/types/CreateTrieveKnowledgeBaseDtoProvider.ts create mode 100644 src/api/types/CustomerSpeechTimeoutOptionsTriggerResetMode.ts create mode 100644 src/api/types/DeepgramTranscriberRedactionItem.ts create mode 100644 src/api/types/ElevenLabsCredentialApiUrl.ts create mode 100644 src/api/types/EndedReasonCondition.ts create mode 100644 src/api/types/EndedReasonConditionOperator.ts create mode 100644 src/api/types/ExportChatDtoSortBy.ts create mode 100644 src/api/types/ExportSessionDtoSortBy.ts create mode 100644 src/api/types/FallbackAssemblyAiTranscriberLanguageCodesItem.ts create mode 100644 src/api/types/FallbackAssemblyAiTranscriberMode.ts create mode 100644 src/api/types/FallbackDeepgramTranscriberRedactionItem.ts rename src/api/types/{GladiaTranscriberLanguages.ts => FallbackGladiaTranscriberLanguagesItem.ts} (84%) create mode 100644 src/api/types/FallbackMicrosoftVoice.ts create mode 100644 src/api/types/FallbackMicrosoftVoiceRole.ts create mode 100644 src/api/types/FallbackMicrosoftVoiceStyle.ts create mode 100644 src/api/types/FallbackMicrosoftVoiceVoiceId.ts create mode 100644 src/api/types/FallbackSonioxTranscriberLanguagesItem.ts create mode 100644 src/api/types/FallbackVapiVoiceLanguage.ts create mode 100644 src/api/types/FallbackVapiVoiceVersion.ts delete mode 100644 src/api/types/FallbackVapiVoiceVoiceId.ts create mode 100644 src/api/types/FallbackXaiTranscriber.ts create mode 100644 src/api/types/FallbackXaiTranscriberLanguage.ts create mode 100644 src/api/types/FallbackXaiTranscriberModel.ts create mode 100644 src/api/types/FallbackXaiVoice.ts create mode 100644 src/api/types/FallbackXaiVoiceLanguage.ts create mode 100644 src/api/types/FallbackXaiVoiceVoiceId.ts create mode 100644 src/api/types/GetChatPaginatedDtoSortBy.ts create mode 100644 src/api/types/GetEvalPaginatedDtoSortBy.ts create mode 100644 src/api/types/GetEvalRunPaginatedDtoSortBy.ts create mode 100644 src/api/types/GetSessionPaginatedDtoSortBy.ts create mode 100644 src/api/types/GetToolDraftsDto.ts rename src/api/types/{FallbackGladiaTranscriberLanguages.ts => GladiaTranscriberLanguagesItem.ts} (82%) create mode 100644 src/api/types/InviteUserDtoRoleZero.ts create mode 100644 src/api/types/KnowledgeBaseTool.ts create mode 100644 src/api/types/KnowledgeBaseToolFunction.ts create mode 100644 src/api/types/KnowledgeBaseToolMessagesItem.ts create mode 100644 src/api/types/KnowledgeBaseV2.ts create mode 100644 src/api/types/KnowledgeBaseV2File.ts create mode 100644 src/api/types/KnowledgeBaseV2FileStatus.ts create mode 100644 src/api/types/KnowledgeBaseV2WithFiles.ts create mode 100644 src/api/types/LegacyAssistantVersion.ts create mode 100644 src/api/types/LegacyAssistantVersionPaginatedResponse.ts rename src/api/types/{TrieveCredential.ts => MicrosoftCredential.ts} (73%) create mode 100644 src/api/types/MicrosoftCredentialProvider.ts create mode 100644 src/api/types/MicrosoftVoice.ts create mode 100644 src/api/types/MicrosoftVoiceRole.ts create mode 100644 src/api/types/MicrosoftVoiceStyle.ts create mode 100644 src/api/types/MicrosoftVoiceVoiceId.ts create mode 100644 src/api/types/MinCallDurationCondition.ts create mode 100644 src/api/types/MinMessagesCondition.ts create mode 100644 src/api/types/NumberComparatorScorecardMetricCondition.ts create mode 100644 src/api/types/NumberComparatorScorecardMetricConditionComparator.ts create mode 100644 src/api/types/NumberComparatorScorecardMetricConditionType.ts create mode 100644 src/api/types/OpenAiModelReasoningEffort.ts create mode 100644 src/api/types/PaginationMetaSortOrder.ts create mode 100644 src/api/types/PendingInvitationDto.ts create mode 100644 src/api/types/PendingInvitationsResponseDto.ts create mode 100644 src/api/types/RecordingConsentPlanStayOnLineFirstMessageMode.ts create mode 100644 src/api/types/RecordingConsentPlanVerbalFirstMessageMode.ts create mode 100644 src/api/types/RecordingConsentType.ts create mode 100644 src/api/types/RevokeInvitationResponseDto.ts create mode 100644 src/api/types/S3CompatibleBucketPlan.ts create mode 100644 src/api/types/S3CompatibleStorageCredential.ts create mode 100644 src/api/types/S3CompatibleStorageCredentialProvider.ts create mode 100644 src/api/types/SayHookActionExact.ts create mode 100644 src/api/types/ScorecardMetricConditionsItem.ts create mode 100644 src/api/types/ServerMessageCallArtifactUpload.ts create mode 100644 src/api/types/ServerMessageCallArtifactUploadPhoneNumber.ts create mode 100644 src/api/types/ServerMessageCallArtifactUploadType.ts create mode 100644 src/api/types/ServerMessageCampaignPredial.ts create mode 100644 src/api/types/ServerMessageCampaignPredialPhoneNumber.ts create mode 100644 src/api/types/ServerMessageCampaignPredialType.ts create mode 100644 src/api/types/ServerMessageResponseCampaignPredial.ts create mode 100644 src/api/types/SimulationRunListItem.ts create mode 100644 src/api/types/SimulationRunListItemSimulationsItem.ts create mode 100644 src/api/types/SimulationRunListItemStatus.ts create mode 100644 src/api/types/SimulationRunListItemTarget.ts create mode 100644 src/api/types/SimulationRunListSource.ts create mode 100644 src/api/types/SimulationRunListSourceType.ts create mode 100644 src/api/types/SimulationRunListSummary.ts create mode 100644 src/api/types/SimulationRunPaymentRequiredResponse.ts create mode 100644 src/api/types/SimulationRunPaymentRequiredResponseReason.ts create mode 100644 src/api/types/SimulationRunsPaginatedResponse.ts create mode 100644 src/api/types/SimulationSuiteTargetAssignment.ts create mode 100644 src/api/types/SimulationSuiteTargetAssignmentTargetType.ts create mode 100644 src/api/types/SkippedStructuredOutput.ts create mode 100644 src/api/types/SkippedStructuredOutputUnmetCondition.ts create mode 100644 src/api/types/SonioxContextGeneralItem.ts create mode 100644 src/api/types/SonioxTranscriberLanguagesItem.ts create mode 100644 src/api/types/StructuredOutputConditionsItem.ts create mode 100644 src/api/types/StructuredOutputCostBreakdown.ts create mode 100644 src/api/types/StructuredOutputRerunResponse.ts create mode 100644 src/api/types/StructuredOutputRunPreviewResponse.ts create mode 100644 src/api/types/StructuredOutputRunResult.ts create mode 100644 src/api/types/StructuredOutputRunResultResult.ts create mode 100644 src/api/types/TelnyxTransport.ts create mode 100644 src/api/types/TelnyxTransportConversationType.ts create mode 100644 src/api/types/ToolCallResultMessageWarning.ts create mode 100644 src/api/types/ToolCallResultMessageWarningType.ts create mode 100644 src/api/types/ToolDraft.ts create mode 100644 src/api/types/ToolDraftConflictResponseDto.ts create mode 100644 src/api/types/ToolDraftMessagesItem.ts create mode 100644 src/api/types/ToolDraftMethod.ts create mode 100644 src/api/types/ToolDraftPaginatedMetadata.ts create mode 100644 src/api/types/ToolDraftPaginatedResponse.ts create mode 100644 src/api/types/ToolDraftType.ts create mode 100644 src/api/types/ToolDraftVerb.ts create mode 100644 src/api/types/ToolMessageFailedRole.ts create mode 100644 src/api/types/ToolPinnedConflictResponseDto.ts create mode 100644 src/api/types/ToolPinnedConflictResponseDtoError.ts create mode 100644 src/api/types/ToolRef.ts create mode 100644 src/api/types/ToolVersion.ts create mode 100644 src/api/types/ToolVersionPaginatedMetadata.ts create mode 100644 src/api/types/ToolVersionPaginatedResponse.ts create mode 100644 src/api/types/TransferArtifact.ts create mode 100644 src/api/types/TransferArtifactDestination.ts create mode 100644 src/api/types/TransferArtifactMessagesItem.ts create mode 100644 src/api/types/TransferArtifactMode.ts create mode 100644 src/api/types/TransferArtifactStatus.ts delete mode 100644 src/api/types/TrieveCredentialProvider.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseChunkPlan.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseCreate.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseCreateType.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseImportType.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseProvider.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseSearchPlan.ts delete mode 100644 src/api/types/TrieveKnowledgeBaseSearchPlanSearchType.ts create mode 100644 src/api/types/TwilioTransport.ts create mode 100644 src/api/types/TwilioTransportConversationType.ts create mode 100644 src/api/types/UpdateAnthropicBedrockCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateAnthropicCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateAnyscaleCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateAssemblyAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateAssistantDraftDto.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoBackgroundSound.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoBackgroundSoundZero.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoClientMessagesItem.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoCredentialsItem.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoFirstMessageMode.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoHooksItem.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoModel.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoServerMessagesItem.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoTranscriber.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoVoice.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoVoicemailDetection.ts create mode 100644 src/api/types/UpdateAssistantDraftDtoVoicemailDetectionZero.ts create mode 100644 src/api/types/UpdateAssistantVersionMetadataDto.ts create mode 100644 src/api/types/UpdateAzureCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateAzureOpenAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateByoSipTrunkCredentialDtoProvider.ts rename src/api/{resources/campaigns/client/requests => types}/UpdateCampaignDto.ts (65%) rename src/api/{resources/campaigns => }/types/UpdateCampaignDtoStatus.ts (54%) create mode 100644 src/api/types/UpdateCartesiaCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateCerebrasCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateCloudflareCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateCodeToolDtoType.ts create mode 100644 src/api/types/UpdateCustomCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateCustomKnowledgeBaseDtoProvider.ts create mode 100644 src/api/types/UpdateCustomLlmCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateDeepInfraCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateDeepSeekCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateDeepgramCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateElevenLabsCredentialDtoApiUrl.ts create mode 100644 src/api/types/UpdateEmailCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGcpCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGhlToolDtoType.ts create mode 100644 src/api/types/UpdateGladiaCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoHighLevelCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoHighLevelMcpCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoogleCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateGroqCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateHumeCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateInflectionAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateInworldCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateKnowledgeBaseToolDto.ts create mode 100644 src/api/types/UpdateKnowledgeBaseToolDtoMessagesItem.ts create mode 100644 src/api/types/UpdateLangfuseCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateLmntCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateMakeCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateMakeToolDtoType.ts create mode 100644 src/api/types/UpdateMicrosoftCredentialDto.ts create mode 100644 src/api/types/UpdateMicrosoftCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateMistralCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateNeuphonicCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateOpenAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateOpenRouterCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateOutputToolDtoType.ts create mode 100644 src/api/types/UpdatePerplexityAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdatePlayHtCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateRimeAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateRunpodCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateS3CompatibleBucketPlanDto.ts create mode 100644 src/api/types/UpdateS3CompatibleCredentialDto.ts create mode 100644 src/api/types/UpdateS3CompatibleCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateS3CredentialDtoProvider.ts create mode 100644 src/api/types/UpdateSlackOAuth2AuthorizationCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateSlackWebhookCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateSonioxCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateTogetherAiCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateToolDraftDto.ts create mode 100644 src/api/types/UpdateToolDraftDtoMessagesItem.ts create mode 100644 src/api/types/UpdateToolDraftDtoMethod.ts create mode 100644 src/api/types/UpdateToolDraftDtoType.ts create mode 100644 src/api/types/UpdateToolDraftDtoVerb.ts create mode 100644 src/api/types/UpdateToolVersionMetadataDto.ts delete mode 100644 src/api/types/UpdateTrieveCredentialDto.ts create mode 100644 src/api/types/UpdateTwilioCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateUserRoleDtoRoleZero.ts create mode 100644 src/api/types/UpdateVoiceLibraryMetadataDto.ts create mode 100644 src/api/types/UpdateVonageCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateWebhookCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateWellSaidCredentialDtoProvider.ts create mode 100644 src/api/types/UpdateXAiCredentialDtoProvider.ts delete mode 100644 src/api/types/VapiModelProvider.ts create mode 100644 src/api/types/VapiModelVersion.ts create mode 100644 src/api/types/VapiPronunciationDictionaryLocatorProvider.ts create mode 100644 src/api/types/VapiSipTransport.ts create mode 100644 src/api/types/VapiSipTransportConversationType.ts create mode 100644 src/api/types/VapiTranscriber.ts create mode 100644 src/api/types/VapiTranscriberLanguage.ts create mode 100644 src/api/types/VapiTranscriberLanguagesItem.ts create mode 100644 src/api/types/VapiTranscriberTurnTaking.ts create mode 100644 src/api/types/VapiTranscriberVersion.ts create mode 100644 src/api/types/VapiVoiceCloneDto.ts create mode 100644 src/api/types/VapiVoiceLanguage.ts create mode 100644 src/api/types/VapiVoiceVersion.ts delete mode 100644 src/api/types/VapiVoiceVoiceId.ts create mode 100644 src/api/types/VapiWebCallTransport.ts create mode 100644 src/api/types/VapiWebCallTransportConversationType.ts create mode 100644 src/api/types/VapiWebsocketTransport.ts create mode 100644 src/api/types/VapiWebsocketTransportConversationType.ts create mode 100644 src/api/types/VersionPinConflictResponseDto.ts create mode 100644 src/api/types/VersionPinConflictResponseDtoError.ts create mode 100644 src/api/types/VersionPinReference.ts create mode 100644 src/api/types/VersionPinReferenceSourceType.ts create mode 100644 src/api/types/VoiceLibraryVoiceResponseAge.ts create mode 100644 src/api/types/VonageTransport.ts create mode 100644 src/api/types/VonageTransportConversationType.ts create mode 100644 src/api/types/XaiTranscriber.ts create mode 100644 src/api/types/XaiTranscriberLanguage.ts create mode 100644 src/api/types/XaiTranscriberModel.ts create mode 100644 src/api/types/XaiVoice.ts create mode 100644 src/api/types/XaiVoiceLanguage.ts create mode 100644 src/api/types/XaiVoiceVoiceId.ts create mode 100644 tests/wire/board.test.ts create mode 100644 tests/wire/knowledgeBasesV2.test.ts create mode 100644 tests/wire/simulationPersonalities.test.ts create mode 100644 tests/wire/simulationRuns.test.ts create mode 100644 tests/wire/simulationScenarios.test.ts create mode 100644 tests/wire/simulationSuites.test.ts create mode 100644 tests/wire/simulations.test.ts diff --git a/.fern/metadata.json b/.fern/metadata.json index fbb2dfd3..8681b9f9 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,5 +1,5 @@ { - "cliVersion": "5.51.2", + "cliVersion": "5.98.3", "generatorName": "fernapi/fern-typescript-sdk", "generatorVersion": "3.63.0", "generatorConfig": { @@ -11,10 +11,10 @@ "omitUndefined": true, "enableInlineTypes": false }, - "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5", + "originGitCommit": "0494c2f3cd88c4fd04b8e98e9a247919270741ed", "originGitCommitIsDirty": true, "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "2.0.0" + "sdkVersion": "0.0.0-fern-placeholder" } diff --git a/.fern/replay.lock b/.fern/replay.lock new file mode 100644 index 00000000..9c98e86e --- /dev/null +++ b/.fern/replay.lock @@ -0,0 +1,10 @@ +# DO NOT EDIT MANUALLY - Managed by Fern Replay +version: "1.0" +generations: + - commit_sha: a1c6092cc00dca56259110e7ad5d14b616d25ed5 + tree_hash: 15237b3bbb8dd236320fd291333325fa5deaa7c4 + timestamp: 2026-08-19T00:22:56.996Z + cli_version: unknown + generator_versions: {} +current_generation: a1c6092cc00dca56259110e7ad5d14b616d25ed5 +patches: [] diff --git a/.fernignore b/.fernignore index 82e7de06..fad339e2 100644 --- a/.fernignore +++ b/.fernignore @@ -3,3 +3,6 @@ .github/workflows/sdk-release-pr-notification.yml README.md changelog.md +.fern/replay.lock +.fern/replay.yml +.gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..74928d6a --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +.fern/replay.lock linguist-generated=true diff --git a/package.json b/package.json index a80436ca..fa9425b9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vapi-ai/server-sdk", - "version": "2.0.0", + "version": "0.0.0-fern-placeholder", "private": false, "repository": { "type": "git", @@ -121,6 +121,17 @@ }, "default": "./dist/cjs/api/resources/files/exports.js" }, + "./knowledgeBasesV2": { + "import": { + "types": "./dist/esm/api/resources/knowledgeBasesV2/exports.d.mts", + "default": "./dist/esm/api/resources/knowledgeBasesV2/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/knowledgeBasesV2/exports.d.ts", + "default": "./dist/cjs/api/resources/knowledgeBasesV2/exports.js" + }, + "default": "./dist/cjs/api/resources/knowledgeBasesV2/exports.js" + }, "./structuredOutputs": { "import": { "types": "./dist/esm/api/resources/structuredOutputs/exports.d.mts", @@ -132,6 +143,61 @@ }, "default": "./dist/cjs/api/resources/structuredOutputs/exports.js" }, + "./simulationPersonalities": { + "import": { + "types": "./dist/esm/api/resources/simulationPersonalities/exports.d.mts", + "default": "./dist/esm/api/resources/simulationPersonalities/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/simulationPersonalities/exports.d.ts", + "default": "./dist/cjs/api/resources/simulationPersonalities/exports.js" + }, + "default": "./dist/cjs/api/resources/simulationPersonalities/exports.js" + }, + "./simulationScenarios": { + "import": { + "types": "./dist/esm/api/resources/simulationScenarios/exports.d.mts", + "default": "./dist/esm/api/resources/simulationScenarios/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/simulationScenarios/exports.d.ts", + "default": "./dist/cjs/api/resources/simulationScenarios/exports.js" + }, + "default": "./dist/cjs/api/resources/simulationScenarios/exports.js" + }, + "./simulationRuns": { + "import": { + "types": "./dist/esm/api/resources/simulationRuns/exports.d.mts", + "default": "./dist/esm/api/resources/simulationRuns/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/simulationRuns/exports.d.ts", + "default": "./dist/cjs/api/resources/simulationRuns/exports.js" + }, + "default": "./dist/cjs/api/resources/simulationRuns/exports.js" + }, + "./simulationSuites": { + "import": { + "types": "./dist/esm/api/resources/simulationSuites/exports.d.mts", + "default": "./dist/esm/api/resources/simulationSuites/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/simulationSuites/exports.d.ts", + "default": "./dist/cjs/api/resources/simulationSuites/exports.js" + }, + "default": "./dist/cjs/api/resources/simulationSuites/exports.js" + }, + "./simulations": { + "import": { + "types": "./dist/esm/api/resources/simulations/exports.d.mts", + "default": "./dist/esm/api/resources/simulations/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/simulations/exports.d.ts", + "default": "./dist/cjs/api/resources/simulations/exports.js" + }, + "default": "./dist/cjs/api/resources/simulations/exports.js" + }, "./insight": { "import": { "types": "./dist/esm/api/resources/insight/exports.d.mts", @@ -143,6 +209,17 @@ }, "default": "./dist/cjs/api/resources/insight/exports.js" }, + "./board": { + "import": { + "types": "./dist/esm/api/resources/board/exports.d.mts", + "default": "./dist/esm/api/resources/board/exports.mjs" + }, + "require": { + "types": "./dist/cjs/api/resources/board/exports.d.ts", + "default": "./dist/cjs/api/resources/board/exports.js" + }, + "default": "./dist/cjs/api/resources/board/exports.js" + }, "./eval": { "import": { "types": "./dist/esm/api/resources/eval/exports.d.mts", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 36c57bd2..ecea96a6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -25,7 +25,7 @@ importers: version: 5.9.3 vitest: specifier: ^4.1.1 - version: 4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)) + version: 4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1)) webpack: specifier: ^5.105.4 version: 5.105.4 @@ -95,14 +95,14 @@ packages: '@bundled-es-modules/statuses@1.0.1': resolution: {integrity: sha512-yn7BklA5acgcBr+7w064fGV+SGIFySjCKpqjcWgBAIfrAkY+4GQTJJHQMeT3V/sgz23VTEVV8TtOmkvJAhFVfg==} - '@emnapi/core@1.11.1': - resolution: {integrity: sha512-RSvbQmHzdKzNsLYa/wHrbc3KN4sYLKAdPZxqiM2HATqv/SBk2/ENSHpvXGaLOMcsAyz0poEGqkmmKYG3OWiJEQ==} + '@emnapi/core@1.11.3': + resolution: {integrity: sha512-zLpS5asjEb7lq8jYLq37N6XKaE41DIexlY1rF/z4/tIl3wo13Sqm28fRyfIsKZD+NZ8mM5RoKkpW/rBcuoSZSg==} - '@emnapi/runtime@1.11.1': - resolution: {integrity: sha512-vgj7R3y3Wgx24IQaGPA/R6YFXLHVMOZ0uVEyIQPaWs+rd1AzfEMXlAC22FYwO1XkKR6NPsq7mUandH8oIRdZFw==} + '@emnapi/runtime@1.11.3': + resolution: {integrity: sha512-Xz4Tpyki7XyrpbUK1jR1AhdAdaXyhhY4lZ3neLodmhpuWfy2PAQN5B46sAiU4liOXGLkHypn/qU+jvfWSCYYLA==} - '@emnapi/wasi-threads@1.2.2': - resolution: {integrity: sha512-c95qOXkHdydNKhscBTebqEC1CVAZpyqOfVfBzQ1qgzyl3gfeldUjIggDbIZgDKsHLgnsM+igH7TJ/eAasaVuMA==} + '@emnapi/wasi-threads@1.2.3': + resolution: {integrity: sha512-ELEBe8PsLvvJ6QMr0zLt8ffvOHW/dc1m3CEzNMg7aJUv3bMaoDtw2TXyDAwkYBuroxxuHEwhRTLJSe5sya547g==} '@inquirer/ansi@1.0.2': resolution: {integrity: sha512-S8qNSZiYzFd0wAcyG5AXCvUHC5Sr7xpZ9wZ2py9XR88jUz8wooStVx5M6dRzczbBWjic9NP7+rY0Xi7qqK/aMQ==} @@ -159,11 +159,12 @@ packages: resolution: {integrity: sha512-2+BzZbjRO7Ct61k8fMNHEtoKjeWI9pIlHFTqBwZ5icHpqszIgEZbjb1MW5Z0+bITTCTl3gk4PDBxs9tA/csXvA==} engines: {node: '>=18'} - '@napi-rs/wasm-runtime@1.1.6': - resolution: {integrity: sha512-ZLv/JdUfkvOy9eCnnBaGfiO+XimbjebAeO+MRQqD/B+FR1tnRN0tpKSJHRbE8sFfS6aqsXZ67TQjfwfsxULVbg==} + '@napi-rs/wasm-runtime@1.2.3': + resolution: {integrity: sha512-UMduMbqO5s5zF2NkNacMT/yK5Y5QiKvWr2+50bzIIxFDwVJ2h49b+oyjaCGPhJxd2/gC2x39EHv/gHVuu36x2Q==} + engines: {node: ^20.19.0 || ^22.13.0 || >=23.5.0} peerDependencies: - '@emnapi/core': ^1.7.1 - '@emnapi/runtime': ^1.7.1 + '@emnapi/core': ^1.7.1 || ^2.0.0-alpha.4 + '@emnapi/runtime': ^1.7.1 || ^2.0.0-alpha.4 '@open-draft/deferred-promise@2.2.0': resolution: {integrity: sha512-CecwLWx3rhxVQF6V4bAgPS5t+So2sTbPgAzafKkVizyi7tlwpcFpdFqq+wqF2OwNBmqFuu6tOyouTuxgpMfzmA==} @@ -598,78 +599,78 @@ packages: json-schema-traverse@1.0.0: resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} - lightningcss-android-arm64@1.32.0: - resolution: {integrity: sha512-YK7/ClTt4kAK0vo6w3X+Pnm0D2cf2vPHbhOXdoNti1Ga0al1P4TBZhwjATvjNwLEBCnKvjJc2jQgHXH0NEwlAg==} + lightningcss-android-arm64@1.33.0: + resolution: {integrity: sha512-gEpRTalKdosp4Bb8qWtc2iOgE5SeIHlpS1up9bFq2wAyYhl1UdTObYiHe98zEM9SQvSoqQZ1IQD0JNpg3Ml5pg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [android] - lightningcss-darwin-arm64@1.32.0: - resolution: {integrity: sha512-RzeG9Ju5bag2Bv1/lwlVJvBE3q6TtXskdZLLCyfg5pt+HLz9BqlICO7LZM7VHNTTn/5PRhHFBSjk5lc4cmscPQ==} + lightningcss-darwin-arm64@1.33.0: + resolution: {integrity: sha512-Sciaz8eenNTKn9b3t7+xr0ipTp9YxKQY4npwQ3mrRuL0BAVHBLyZxofhaKBAVtzmtRZ/zTyo0/to4B1uWG/Djg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [darwin] - lightningcss-darwin-x64@1.32.0: - resolution: {integrity: sha512-U+QsBp2m/s2wqpUYT/6wnlagdZbtZdndSmut/NJqlCcMLTWp5muCrID+K5UJ6jqD2BFshejCYXniPDbNh73V8w==} + lightningcss-darwin-x64@1.33.0: + resolution: {integrity: sha512-Z5UPAxzrjlWNNyGy6i65cJzzvgJ5D3T6wMvs+gWpY9d7qRhANrxqAp6LhxIgZhWEw18RfJTGcRxjuLIBr+m8XQ==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [darwin] - lightningcss-freebsd-x64@1.32.0: - resolution: {integrity: sha512-JCTigedEksZk3tHTTthnMdVfGf61Fky8Ji2E4YjUTEQX14xiy/lTzXnu1vwiZe3bYe0q+SpsSH/CTeDXK6WHig==} + lightningcss-freebsd-x64@1.33.0: + resolution: {integrity: sha512-QQM/Ti/hQajJwCY+RiWuCZ9sdtI/XQk7nDK5vC8kkdwixezOlDgvDx7+RT+QjK6FcFT4MpsuoBnHIo/O3StRRg==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [freebsd] - lightningcss-linux-arm-gnueabihf@1.32.0: - resolution: {integrity: sha512-x6rnnpRa2GL0zQOkt6rts3YDPzduLpWvwAF6EMhXFVZXD4tPrBkEFqzGowzCsIWsPjqSK+tyNEODUBXeeVHSkw==} + lightningcss-linux-arm-gnueabihf@1.33.0: + resolution: {integrity: sha512-N7FVBe6iS24MlM6R/4RBTxGhQheZGs7tiQ9U32UtF75NzP5Q7xWPRqLBCKxlRQRk3rY1jCIPLzx7WzOhuUIRLQ==} engines: {node: '>= 12.0.0'} cpu: [arm] os: [linux] - lightningcss-linux-arm64-gnu@1.32.0: - resolution: {integrity: sha512-0nnMyoyOLRJXfbMOilaSRcLH3Jw5z9HDNGfT/gwCPgaDjnx0i8w7vBzFLFR1f6CMLKF8gVbebmkUN3fa/kQJpQ==} + lightningcss-linux-arm64-gnu@1.33.0: + resolution: {integrity: sha512-j2v/itmy4HlNxlc6voKXYgBqNi0Ng2LShg4z7GufpEgs05P+2suBVyi9I6YHq5uoVFx9ETin3eCEhLVyXGQnKg==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] libc: [glibc] - lightningcss-linux-arm64-musl@1.32.0: - resolution: {integrity: sha512-UpQkoenr4UJEzgVIYpI80lDFvRmPVg6oqboNHfoH4CQIfNA+HOrZ7Mo7KZP02dC6LjghPQJeBsvXhJod/wnIBg==} + lightningcss-linux-arm64-musl@1.33.0: + resolution: {integrity: sha512-yiO5ROMuYQgXbC60yjZU5CYSFZGKXL0HFATXt9mHJn1+zW55oCtMI9NfcVhYLMFDL7gV7oBPon/EmMMGg2OvtQ==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [linux] libc: [musl] - lightningcss-linux-x64-gnu@1.32.0: - resolution: {integrity: sha512-V7Qr52IhZmdKPVr+Vtw8o+WLsQJYCTd8loIfpDaMRWGUZfBOYEJeyJIkqGIDMZPwPx24pUMfwSxxI8phr/MbOA==} + lightningcss-linux-x64-gnu@1.33.0: + resolution: {integrity: sha512-ar+Ju7LmcN0Jo4FpL4hpFybwNG9/3A/Br5KW2n2jyODg3MEZXaDYADdemoNS+BDNfMgKvylJLj4S5tyRActuAg==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] libc: [glibc] - lightningcss-linux-x64-musl@1.32.0: - resolution: {integrity: sha512-bYcLp+Vb0awsiXg/80uCRezCYHNg1/l3mt0gzHnWV9XP1W5sKa5/TCdGWaR/zBM2PeF/HbsQv/j2URNOiVuxWg==} + lightningcss-linux-x64-musl@1.33.0: + resolution: {integrity: sha512-RYiYbkokw0trfKqqzfF55lginwEPrD3OJDfTuJzFs1MK6iFnDenaz1fqLLtX4ITG3OktJQXOeTaw1awrBAlZPw==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [linux] libc: [musl] - lightningcss-win32-arm64-msvc@1.32.0: - resolution: {integrity: sha512-8SbC8BR40pS6baCM8sbtYDSwEVQd4JlFTOlaD3gWGHfThTcABnNDBda6eTZeqbofalIJhFx0qKzgHJmcPTnGdw==} + lightningcss-win32-arm64-msvc@1.33.0: + resolution: {integrity: sha512-1K+MPfLSFVpphzpdbfkhlWk6wBrTObBzS2T6db10PNOZgR9GoVsAWzwNyuhUYYbTp23j+4RrncfujZ4uAzXvwA==} engines: {node: '>= 12.0.0'} cpu: [arm64] os: [win32] - lightningcss-win32-x64-msvc@1.32.0: - resolution: {integrity: sha512-Amq9B/SoZYdDi1kFrojnoqPLxYhQ4Wo5XiL8EVJrVsB8ARoC1PWW6VGtT0WKCemjy8aC+louJnjS7U18x3b06Q==} + lightningcss-win32-x64-msvc@1.33.0: + resolution: {integrity: sha512-OlEICDx/Xl0FqSp4bry8zFnCvGpig3Gl4gCquvYwHuqJKEC1+n9NgDniFvqHGmMv1ZkqDJrDqKKSykTDX+ehuA==} engines: {node: '>= 12.0.0'} cpu: [x64] os: [win32] - lightningcss@1.32.0: - resolution: {integrity: sha512-NXYBzinNrblfraPGyrbPoD19C1h9lfI/1mzgWYvXUTe414Gz/X1FD2XBZSZM7rRTrMA8JL3OtAaGifrIKhQ5yQ==} + lightningcss@1.33.0: + resolution: {integrity: sha512-WkUDrojuJs0xkgGf2udWxa3yGBRxPtxUkB79i6aCZLRgc7PM8fZe9TosfPDcvEpQZbuFASnHYmRLBLUbmLOIIA==} engines: {node: '>= 12.0.0'} loader-runner@4.3.1: @@ -719,8 +720,8 @@ packages: node-releases@2.0.37: resolution: {integrity: sha512-1h5gKZCF+pO/o3Iqt5Jp7wc9rH3eJJ0+nh/CIoiRwjRxde/hAHyLPXYN4V3CqKAbiZPSeJFSWHmJsbkicta0Eg==} - obug@2.1.3: - resolution: {integrity: sha512-9miFgM2OFba7hB+pRgvtV84pYTBaoTHohvmIgiRt6dRIzbwEOIaNaP+dIlGs2fNFoB0SeISs0Jz5WFVRid6Xyg==} + obug@2.1.4: + resolution: {integrity: sha512-4a+OsYv9UktOJKE+l1A4OufDgdRF9PifWj+tJnHURo/P+WOxpG4GzUFL9qCalmWauao6ogiG+QvnCovwPoyAWA==} engines: {node: '>=12.20.0'} outvariant@1.4.3: @@ -1076,18 +1077,18 @@ snapshots: dependencies: statuses: 2.0.2 - '@emnapi/core@1.11.1': + '@emnapi/core@1.11.3': dependencies: - '@emnapi/wasi-threads': 1.2.2 + '@emnapi/wasi-threads': 1.2.3 tslib: 2.8.1 optional: true - '@emnapi/runtime@1.11.1': + '@emnapi/runtime@1.11.3': dependencies: tslib: 2.8.1 optional: true - '@emnapi/wasi-threads@1.2.2': + '@emnapi/wasi-threads@1.2.3': dependencies: tslib: 2.8.1 optional: true @@ -1148,10 +1149,10 @@ snapshots: outvariant: 1.4.3 strict-event-emitter: 0.5.1 - '@napi-rs/wasm-runtime@1.1.6(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)': + '@napi-rs/wasm-runtime@1.2.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)': dependencies: - '@emnapi/core': 1.11.1 - '@emnapi/runtime': 1.11.1 + '@emnapi/core': 1.11.3 + '@emnapi/runtime': 1.11.3 '@tybys/wasm-util': 0.10.3 optional: true @@ -1202,9 +1203,9 @@ snapshots: '@rolldown/binding-openharmony-arm64@1.0.0-rc.12': optional: true - '@rolldown/binding-wasm32-wasi@1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)': + '@rolldown/binding-wasm32-wasi@1.0.0-rc.12(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)': dependencies: - '@napi-rs/wasm-runtime': 1.1.6(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + '@napi-rs/wasm-runtime': 1.2.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3) transitivePeerDependencies: - '@emnapi/core' - '@emnapi/runtime' @@ -1263,14 +1264,14 @@ snapshots: chai: 6.2.2 tinyrainbow: 3.1.0 - '@vitest/mocker@4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1))': + '@vitest/mocker@4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1))': dependencies: '@vitest/spy': 4.1.2 estree-walker: 3.0.3 magic-string: 0.30.21 optionalDependencies: msw: 2.11.2(@types/node@18.19.130)(typescript@5.9.3) - vite: 8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1) + vite: 8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1) '@vitest/pretty-format@4.1.2': dependencies: @@ -1532,54 +1533,54 @@ snapshots: json-schema-traverse@1.0.0: {} - lightningcss-android-arm64@1.32.0: + lightningcss-android-arm64@1.33.0: optional: true - lightningcss-darwin-arm64@1.32.0: + lightningcss-darwin-arm64@1.33.0: optional: true - lightningcss-darwin-x64@1.32.0: + lightningcss-darwin-x64@1.33.0: optional: true - lightningcss-freebsd-x64@1.32.0: + lightningcss-freebsd-x64@1.33.0: optional: true - lightningcss-linux-arm-gnueabihf@1.32.0: + lightningcss-linux-arm-gnueabihf@1.33.0: optional: true - lightningcss-linux-arm64-gnu@1.32.0: + lightningcss-linux-arm64-gnu@1.33.0: optional: true - lightningcss-linux-arm64-musl@1.32.0: + lightningcss-linux-arm64-musl@1.33.0: optional: true - lightningcss-linux-x64-gnu@1.32.0: + lightningcss-linux-x64-gnu@1.33.0: optional: true - lightningcss-linux-x64-musl@1.32.0: + lightningcss-linux-x64-musl@1.33.0: optional: true - lightningcss-win32-arm64-msvc@1.32.0: + lightningcss-win32-arm64-msvc@1.33.0: optional: true - lightningcss-win32-x64-msvc@1.32.0: + lightningcss-win32-x64-msvc@1.33.0: optional: true - lightningcss@1.32.0: + lightningcss@1.33.0: dependencies: detect-libc: 2.1.2 optionalDependencies: - lightningcss-android-arm64: 1.32.0 - lightningcss-darwin-arm64: 1.32.0 - lightningcss-darwin-x64: 1.32.0 - lightningcss-freebsd-x64: 1.32.0 - lightningcss-linux-arm-gnueabihf: 1.32.0 - lightningcss-linux-arm64-gnu: 1.32.0 - lightningcss-linux-arm64-musl: 1.32.0 - lightningcss-linux-x64-gnu: 1.32.0 - lightningcss-linux-x64-musl: 1.32.0 - lightningcss-win32-arm64-msvc: 1.32.0 - lightningcss-win32-x64-msvc: 1.32.0 + lightningcss-android-arm64: 1.33.0 + lightningcss-darwin-arm64: 1.33.0 + lightningcss-darwin-x64: 1.33.0 + lightningcss-freebsd-x64: 1.33.0 + lightningcss-linux-arm-gnueabihf: 1.33.0 + lightningcss-linux-arm64-gnu: 1.33.0 + lightningcss-linux-arm64-musl: 1.33.0 + lightningcss-linux-x64-gnu: 1.33.0 + lightningcss-linux-x64-musl: 1.33.0 + lightningcss-win32-arm64-msvc: 1.33.0 + lightningcss-win32-x64-msvc: 1.33.0 loader-runner@4.3.1: {} @@ -1634,7 +1635,7 @@ snapshots: node-releases@2.0.37: {} - obug@2.1.3: {} + obug@2.1.4: {} outvariant@1.4.3: {} @@ -1660,7 +1661,7 @@ snapshots: rettime@0.7.0: {} - rolldown@1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1): + rolldown@1.0.0-rc.12(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3): dependencies: '@oxc-project/types': 0.122.0 '@rolldown/pluginutils': 1.0.0-rc.12 @@ -1677,7 +1678,7 @@ snapshots: '@rolldown/binding-linux-x64-gnu': 1.0.0-rc.12 '@rolldown/binding-linux-x64-musl': 1.0.0-rc.12 '@rolldown/binding-openharmony-arm64': 1.0.0-rc.12 - '@rolldown/binding-wasm32-wasi': 1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + '@rolldown/binding-wasm32-wasi': 1.0.0-rc.12(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3) '@rolldown/binding-win32-arm64-msvc': 1.0.0-rc.12 '@rolldown/binding-win32-x64-msvc': 1.0.0-rc.12 transitivePeerDependencies: @@ -1801,12 +1802,12 @@ snapshots: escalade: 3.2.0 picocolors: 1.1.1 - vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1): + vite@8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1): dependencies: - lightningcss: 1.32.0 + lightningcss: 1.33.0 picomatch: 4.0.4 postcss: 8.5.8 - rolldown: 1.0.0-rc.12(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1) + rolldown: 1.0.0-rc.12(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3) tinyglobby: 0.2.15 optionalDependencies: '@types/node': 18.19.130 @@ -1816,10 +1817,10 @@ snapshots: - '@emnapi/core' - '@emnapi/runtime' - vitest@4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)): + vitest@4.1.2(@types/node@18.19.130)(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1)): dependencies: '@vitest/expect': 4.1.2 - '@vitest/mocker': 4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1)) + '@vitest/mocker': 4.1.2(msw@2.11.2(@types/node@18.19.130)(typescript@5.9.3))(vite@8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1)) '@vitest/pretty-format': 4.1.2 '@vitest/runner': 4.1.2 '@vitest/snapshot': 4.1.2 @@ -1828,7 +1829,7 @@ snapshots: es-module-lexer: 2.0.0 expect-type: 1.3.0 magic-string: 0.30.21 - obug: 2.1.3 + obug: 2.1.4 pathe: 2.0.3 picomatch: 4.0.4 std-env: 4.0.0 @@ -1836,7 +1837,7 @@ snapshots: tinyexec: 1.0.4 tinyglobby: 0.2.15 tinyrainbow: 3.1.0 - vite: 8.0.3(@emnapi/core@1.11.1)(@emnapi/runtime@1.11.1)(@types/node@18.19.130)(terser@5.46.1) + vite: 8.0.3(@emnapi/core@1.11.3)(@emnapi/runtime@1.11.3)(@types/node@18.19.130)(terser@5.46.1) why-is-node-running: 2.3.0 optionalDependencies: '@types/node': 18.19.130 diff --git a/reference.md b/reference.md index 962778e6..477b49bb 100644 --- a/reference.md +++ b/reference.md @@ -4,6 +4,20 @@
+#### 📝 Description + +
+
+ +
+
+ +Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -53,6 +67,20 @@ await client.assistants.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. +
+
+
+
+ #### 🔌 Usage
@@ -102,6 +130,20 @@ await client.assistants.create({});
+#### 📝 Description + +
+
+ +
+
+ +Returns the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -153,6 +195,20 @@ await client.assistants.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -204,6 +260,20 @@ await client.assistants.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -256,6 +326,20 @@ await client.assistants.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -305,6 +389,20 @@ await client.squads.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a squad that coordinates multiple assistants and their handoffs during a conversation. +
+
+
+
+ #### 🔌 Usage
@@ -356,6 +454,20 @@ await client.squads.create({
+#### 📝 Description + +
+
+ +
+
+ +Returns the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -407,6 +519,20 @@ await client.squads.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -458,6 +584,20 @@ await client.squads.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -511,6 +651,20 @@ await client.squads.update({
+#### 📝 Description + +
+
+ +
+
+ +Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -560,6 +714,20 @@ await client.calls.list();
+#### 📝 Description + +
+
+ +
+
+ +Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. +
+
+
+
+ #### 🔌 Usage
@@ -609,6 +777,20 @@ await client.calls.create();
+#### 📝 Description + +
+
+ +
+
+ +Returns the call identified by its ID, including its status, configuration, and available call data. +
+
+
+
+ #### 🔌 Usage
@@ -660,6 +842,20 @@ await client.calls.get({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -711,6 +907,20 @@ await client.calls.delete({
+#### 📝 Description + +
+
+ +
+
+ +Updates the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -758,8 +968,7 @@ await client.calls.update({
-## Chats -
client.chats.list({ ...params }) -> Vapi.ChatPaginatedResponse +
client.calls.callArtifactControllerMonoRecordingDownload({ ...params }) -> void
@@ -772,8 +981,8 @@ await client.calls.update({
```typescript -await client.chats.list({ - assistantIdAny: "assistant-1,assistant-2,assistant-3" +await client.calls.callArtifactControllerMonoRecordingDownload({ + id: "id" }); ``` @@ -790,7 +999,7 @@ await client.chats.list({
-**request:** `Vapi.ListChatsRequest` +**request:** `Vapi.CallArtifactControllerMonoRecordingDownloadRequest`
@@ -798,7 +1007,7 @@ await client.chats.list({
-**requestOptions:** `ChatsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -810,24 +1019,10 @@ await client.chats.list({
-
client.chats.create({ ...params }) -> Vapi.CreateChatsResponse -
-
- -#### 📝 Description - -
-
- +
client.calls.callArtifactControllerStereoRecordingDownload({ ...params }) -> void
-Creates a new chat with optional SMS delivery via transport field. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive. Transport field enables SMS delivery with two modes: (1) New conversation - provide transport.phoneNumberId and transport.customer to create a new session, (2) Existing conversation - provide sessionId to use existing session data. Cannot specify both sessionId and transport fields together. The transport.useLLMGeneratedMessageForOutbound flag controls whether input is processed by LLM (true, default) or forwarded directly as SMS (false). -
-
-
-
- #### 🔌 Usage
@@ -837,8 +1032,8 @@ Creates a new chat with optional SMS delivery via transport field. Requires at l
```typescript -await client.chats.create({ - input: "input" +await client.calls.callArtifactControllerStereoRecordingDownload({ + id: "id" }); ``` @@ -855,7 +1050,7 @@ await client.chats.create({
-**request:** `Vapi.CreateChatDto` +**request:** `Vapi.CallArtifactControllerStereoRecordingDownloadRequest`
@@ -863,7 +1058,7 @@ await client.chats.create({
-**requestOptions:** `ChatsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -875,7 +1070,7 @@ await client.chats.create({
-
client.chats.get({ ...params }) -> Vapi.Chat +
client.calls.callArtifactControllerVideoRecordingDownload({ ...params }) -> void
@@ -888,7 +1083,7 @@ await client.chats.create({
```typescript -await client.chats.get({ +await client.calls.callArtifactControllerVideoRecordingDownload({ id: "id" }); @@ -906,7 +1101,7 @@ await client.chats.get({
-**request:** `Vapi.GetChatsRequest` +**request:** `Vapi.CallArtifactControllerVideoRecordingDownloadRequest`
@@ -914,7 +1109,7 @@ await client.chats.get({
-**requestOptions:** `ChatsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -926,7 +1121,7 @@ await client.chats.get({
-
client.chats.delete({ ...params }) -> Vapi.Chat +
client.calls.callArtifactControllerCustomerRecordingDownload({ ...params }) -> void
@@ -939,7 +1134,7 @@ await client.chats.get({
```typescript -await client.chats.delete({ +await client.calls.callArtifactControllerCustomerRecordingDownload({ id: "id" }); @@ -957,7 +1152,7 @@ await client.chats.delete({
-**request:** `Vapi.DeleteChatsRequest` +**request:** `Vapi.CallArtifactControllerCustomerRecordingDownloadRequest`
@@ -965,7 +1160,7 @@ await client.chats.delete({
-**requestOptions:** `ChatsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -977,7 +1172,7 @@ await client.chats.delete({
-
client.chats.createResponse({ ...params }) -> Vapi.CreateResponseChatsResponse +
client.calls.callArtifactControllerAssistantRecordingDownload({ ...params }) -> void
@@ -990,8 +1185,8 @@ await client.chats.delete({
```typescript -await client.chats.createResponse({ - input: "input" +await client.calls.callArtifactControllerAssistantRecordingDownload({ + id: "id" }); ``` @@ -1008,7 +1203,7 @@ await client.chats.createResponse({
-**request:** `Vapi.OpenAiResponsesRequest` +**request:** `Vapi.CallArtifactControllerAssistantRecordingDownloadRequest`
@@ -1016,7 +1211,7 @@ await client.chats.createResponse({
-**requestOptions:** `ChatsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -1028,8 +1223,7 @@ await client.chats.createResponse({
-## Campaigns -
client.campaigns.campaignControllerFindAll({ ...params }) -> Vapi.CampaignPaginatedResponse +
client.calls.callArtifactControllerPcapDownload({ ...params }) -> void
@@ -1042,7 +1236,9 @@ await client.chats.createResponse({
```typescript -await client.campaigns.campaignControllerFindAll(); +await client.calls.callArtifactControllerPcapDownload({ + id: "id" +}); ```
@@ -1058,7 +1254,7 @@ await client.campaigns.campaignControllerFindAll();
-**request:** `Vapi.CampaignControllerFindAllRequest` +**request:** `Vapi.CallArtifactControllerPcapDownloadRequest`
@@ -1066,7 +1262,7 @@ await client.campaigns.campaignControllerFindAll();
-**requestOptions:** `CampaignsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -1078,7 +1274,7 @@ await client.campaigns.campaignControllerFindAll();
-
client.campaigns.campaignControllerCreate({ ...params }) -> Vapi.Campaign +
client.calls.callArtifactControllerCallLogsDownload({ ...params }) -> void
@@ -1091,8 +1287,8 @@ await client.campaigns.campaignControllerFindAll();
```typescript -await client.campaigns.campaignControllerCreate({ - name: "Q2 Sales Campaign" +await client.calls.callArtifactControllerCallLogsDownload({ + id: "id" }); ``` @@ -1109,7 +1305,7 @@ await client.campaigns.campaignControllerCreate({
-**request:** `Vapi.CreateCampaignDto` +**request:** `Vapi.CallArtifactControllerCallLogsDownloadRequest`
@@ -1117,7 +1313,7 @@ await client.campaigns.campaignControllerCreate({
-**requestOptions:** `CampaignsClient.RequestOptions` +**requestOptions:** `CallsClient.RequestOptions`
@@ -1129,7 +1325,8 @@ await client.campaigns.campaignControllerCreate({
-
client.campaigns.campaignControllerFindOne({ ...params }) -> Vapi.Campaign +## Chats +
client.chats.list({ ...params }) -> Vapi.ChatPaginatedResponse
@@ -1142,8 +1339,8 @@ await client.campaigns.campaignControllerCreate({
```typescript -await client.campaigns.campaignControllerFindOne({ - id: "id" +await client.chats.list({ + assistantIdAny: "assistant-1,assistant-2,assistant-3" }); ``` @@ -1160,7 +1357,7 @@ await client.campaigns.campaignControllerFindOne({
-**request:** `Vapi.CampaignControllerFindOneRequest` +**request:** `Vapi.ListChatsRequest`
@@ -1168,7 +1365,7 @@ await client.campaigns.campaignControllerFindOne({
-**requestOptions:** `CampaignsClient.RequestOptions` +**requestOptions:** `ChatsClient.RequestOptions`
@@ -1180,10 +1377,24 @@ await client.campaigns.campaignControllerFindOne({
-
client.campaigns.campaignControllerRemove({ ...params }) -> Vapi.Campaign +
client.chats.create({ ...params }) -> Vapi.CreateChatsResponse +
+
+ +#### 📝 Description + +
+
+
+Creates a new chat with optional SMS delivery via transport field. Requires at least one of: assistantId/assistant, sessionId, or previousChatId. Note: sessionId and previousChatId are mutually exclusive. Transport field enables SMS delivery with two modes: (1) New conversation - provide transport.phoneNumberId and transport.customer to create a new session, (2) Existing conversation - provide sessionId to use existing session data. Cannot specify both sessionId and transport fields together. The transport.useLLMGeneratedMessageForOutbound flag controls whether input is processed by LLM (true, default) or forwarded directly as SMS (false). +
+
+
+
+ #### 🔌 Usage
@@ -1193,8 +1404,8 @@ await client.campaigns.campaignControllerFindOne({
```typescript -await client.campaigns.campaignControllerRemove({ - id: "id" +await client.chats.create({ + input: "input" }); ``` @@ -1211,7 +1422,7 @@ await client.campaigns.campaignControllerRemove({
-**request:** `Vapi.CampaignControllerRemoveRequest` +**request:** `Vapi.CreateChatDto`
@@ -1219,7 +1430,7 @@ await client.campaigns.campaignControllerRemove({
-**requestOptions:** `CampaignsClient.RequestOptions` +**requestOptions:** `ChatsClient.RequestOptions`
@@ -1231,7 +1442,7 @@ await client.campaigns.campaignControllerRemove({
-
client.campaigns.campaignControllerUpdate({ ...params }) -> Vapi.Campaign +
client.chats.get({ ...params }) -> Vapi.Chat
@@ -1244,7 +1455,7 @@ await client.campaigns.campaignControllerRemove({
```typescript -await client.campaigns.campaignControllerUpdate({ +await client.chats.get({ id: "id" }); @@ -1262,7 +1473,7 @@ await client.campaigns.campaignControllerUpdate({
-**request:** `Vapi.UpdateCampaignDto` +**request:** `Vapi.GetChatsRequest`
@@ -1270,7 +1481,7 @@ await client.campaigns.campaignControllerUpdate({
-**requestOptions:** `CampaignsClient.RequestOptions` +**requestOptions:** `ChatsClient.RequestOptions`
@@ -1282,8 +1493,7 @@ await client.campaigns.campaignControllerUpdate({
-## Sessions -
client.sessions.list({ ...params }) -> Vapi.SessionPaginatedResponse +
client.chats.delete({ ...params }) -> Vapi.Chat
@@ -1296,9 +1506,8 @@ await client.campaigns.campaignControllerUpdate({
```typescript -await client.sessions.list({ - assistantIdAny: "assistant-1,assistant-2,assistant-3", - customerNumberAny: "+1234567890,+0987654321" +await client.chats.delete({ + id: "id" }); ``` @@ -1315,7 +1524,7 @@ await client.sessions.list({
-**request:** `Vapi.ListSessionsRequest` +**request:** `Vapi.DeleteChatsRequest`
@@ -1323,7 +1532,7 @@ await client.sessions.list({
-**requestOptions:** `SessionsClient.RequestOptions` +**requestOptions:** `ChatsClient.RequestOptions`
@@ -1335,7 +1544,7 @@ await client.sessions.list({
-
client.sessions.create({ ...params }) -> Vapi.Session +
client.chats.createResponse({ ...params }) -> Vapi.CreateResponseChatsResponse
@@ -1348,7 +1557,9 @@ await client.sessions.list({
```typescript -await client.sessions.create(); +await client.chats.createResponse({ + input: "input" +}); ```
@@ -1364,7 +1575,7 @@ await client.sessions.create();
-**request:** `Vapi.CreateSessionDto` +**request:** `Vapi.OpenAiResponsesRequest`
@@ -1372,7 +1583,7 @@ await client.sessions.create();
-**requestOptions:** `SessionsClient.RequestOptions` +**requestOptions:** `ChatsClient.RequestOptions`
@@ -1384,10 +1595,25 @@ await client.sessions.create();
-
client.sessions.get({ ...params }) -> Vapi.Session +## Campaigns +
client.campaigns.campaignControllerFindAll({ ...params }) -> Vapi.CampaignPaginatedResponse +
+
+ +#### 📝 Description +
+
+
+ +Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -1397,9 +1623,7 @@ await client.sessions.create();
```typescript -await client.sessions.get({ - id: "id" -}); +await client.campaigns.campaignControllerFindAll(); ```
@@ -1415,7 +1639,7 @@ await client.sessions.get({
-**request:** `Vapi.GetSessionsRequest` +**request:** `Vapi.CampaignControllerFindAllRequest`
@@ -1423,7 +1647,7 @@ await client.sessions.get({
-**requestOptions:** `SessionsClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1435,10 +1659,24 @@ await client.sessions.get({
-
client.sessions.delete({ ...params }) -> Vapi.Session +
client.campaigns.campaignControllerCreate({ ...params }) -> Vapi.Campaign +
+
+ +#### 📝 Description + +
+
+
+Creates an outbound calling campaign that calls a set of customers. +
+
+
+
+ #### 🔌 Usage
@@ -1448,8 +1686,8 @@ await client.sessions.get({
```typescript -await client.sessions.delete({ - id: "id" +await client.campaigns.campaignControllerCreate({ + name: "Q2 Sales Campaign" }); ``` @@ -1466,7 +1704,7 @@ await client.sessions.delete({
-**request:** `Vapi.DeleteSessionsRequest` +**request:** `Vapi.CreateCampaignDto`
@@ -1474,7 +1712,7 @@ await client.sessions.delete({
-**requestOptions:** `SessionsClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1486,7 +1724,7 @@ await client.sessions.delete({
-
client.sessions.update({ ...params }) -> Vapi.Session +
client.campaigns.campaignControllerFindAllV2({ ...params }) -> Vapi.CampaignSummaryPaginatedResponse
@@ -1499,9 +1737,7 @@ await client.sessions.delete({
```typescript -await client.sessions.update({ - id: "id" -}); +await client.campaigns.campaignControllerFindAllV2(); ```
@@ -1517,7 +1753,7 @@ await client.sessions.update({
-**request:** `Vapi.UpdateSessionDto` +**request:** `Vapi.CampaignControllerFindAllV2Request`
@@ -1525,7 +1761,7 @@ await client.sessions.update({
-**requestOptions:** `SessionsClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1537,8 +1773,7 @@ await client.sessions.update({
-## PhoneNumbers -
client.phoneNumbers.list({ ...params }) -> Vapi.ListPhoneNumbersResponseItem[] +
client.campaigns.campaignControllerCreateV2({ ...params }) -> Vapi.Campaign
@@ -1551,7 +1786,9 @@ await client.sessions.update({
```typescript -await client.phoneNumbers.list(); +await client.campaigns.campaignControllerCreateV2({ + name: "Q2 Sales Campaign" +}); ```
@@ -1567,7 +1804,7 @@ await client.phoneNumbers.list();
-**request:** `Vapi.ListPhoneNumbersRequest` +**request:** `Vapi.CreateCampaignDto`
@@ -1575,7 +1812,7 @@ await client.phoneNumbers.list();
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1587,7 +1824,7 @@ await client.phoneNumbers.list();
-
client.phoneNumbers.create({ ...params }) -> Vapi.CreatePhoneNumbersResponse +
client.campaigns.campaignControllerFindOneV2({ ...params }) -> Vapi.CampaignSummary
@@ -1600,9 +1837,8 @@ await client.phoneNumbers.list();
```typescript -await client.phoneNumbers.create({ - provider: "byo-phone-number", - credentialId: "credentialId" +await client.campaigns.campaignControllerFindOneV2({ + id: "id" }); ``` @@ -1619,7 +1855,7 @@ await client.phoneNumbers.create({
-**request:** `Vapi.CreatePhoneNumbersRequest` +**request:** `Vapi.CampaignControllerFindOneV2Request`
@@ -1627,7 +1863,7 @@ await client.phoneNumbers.create({
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1639,7 +1875,7 @@ await client.phoneNumbers.create({
-
client.phoneNumbers.phoneNumberControllerFindAllPaginated({ ...params }) -> Vapi.PhoneNumberPaginatedResponse +
client.campaigns.campaignControllerRemoveV2({ ...params }) -> Vapi.Campaign
@@ -1652,7 +1888,9 @@ await client.phoneNumbers.create({
```typescript -await client.phoneNumbers.phoneNumberControllerFindAllPaginated(); +await client.campaigns.campaignControllerRemoveV2({ + id: "id" +}); ```
@@ -1668,7 +1906,7 @@ await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
-**request:** `Vapi.PhoneNumberControllerFindAllPaginatedRequest` +**request:** `Vapi.CampaignControllerRemoveV2Request`
@@ -1676,7 +1914,7 @@ await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1688,7 +1926,7 @@ await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
-
client.phoneNumbers.get({ ...params }) -> Vapi.GetPhoneNumbersResponse +
client.campaigns.campaignControllerUpdateV2({ ...params }) -> Vapi.Campaign
@@ -1701,8 +1939,9 @@ await client.phoneNumbers.phoneNumberControllerFindAllPaginated();
```typescript -await client.phoneNumbers.get({ - id: "id" +await client.campaigns.campaignControllerUpdateV2({ + id: "id", + body: {} }); ``` @@ -1719,7 +1958,7 @@ await client.phoneNumbers.get({
-**request:** `Vapi.GetPhoneNumbersRequest` +**request:** `Vapi.CampaignControllerUpdateV2Request`
@@ -1727,7 +1966,7 @@ await client.phoneNumbers.get({
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1739,10 +1978,24 @@ await client.phoneNumbers.get({
-
client.phoneNumbers.delete({ ...params }) -> Vapi.DeletePhoneNumbersResponse +
client.campaigns.campaignControllerFindOne({ ...params }) -> Vapi.Campaign +
+
+ +#### 📝 Description +
+
+
+ +Returns the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1752,7 +2005,7 @@ await client.phoneNumbers.get({
```typescript -await client.phoneNumbers.delete({ +await client.campaigns.campaignControllerFindOne({ id: "id" }); @@ -1770,7 +2023,7 @@ await client.phoneNumbers.delete({
-**request:** `Vapi.DeletePhoneNumbersRequest` +**request:** `Vapi.CampaignControllerFindOneRequest`
@@ -1778,7 +2031,7 @@ await client.phoneNumbers.delete({
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1790,10 +2043,24 @@ await client.phoneNumbers.delete({
-
client.phoneNumbers.update({ ...params }) -> Vapi.UpdatePhoneNumbersResponse +
client.campaigns.campaignControllerRemove({ ...params }) -> Vapi.Campaign +
+
+ +#### 📝 Description + +
+
+
+Deletes the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1803,11 +2070,8 @@ await client.phoneNumbers.delete({
```typescript -await client.phoneNumbers.update({ - id: "id", - body: { - provider: "byo-phone-number" - } +await client.campaigns.campaignControllerRemove({ + id: "id" }); ``` @@ -1824,7 +2088,7 @@ await client.phoneNumbers.update({
-**request:** `Vapi.UpdatePhoneNumbersRequest` +**request:** `Vapi.CampaignControllerRemoveRequest`
@@ -1832,7 +2096,7 @@ await client.phoneNumbers.update({
-**requestOptions:** `PhoneNumbersClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1844,11 +2108,24 @@ await client.phoneNumbers.update({
-## Tools -
client.tools.list({ ...params }) -> Vapi.ListToolsResponseItem[] +
client.campaigns.campaignControllerUpdate({ ...params }) -> Vapi.Campaign +
+
+ +#### 📝 Description +
+
+
+ +Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. +
+
+
+
+ #### 🔌 Usage
@@ -1858,7 +2135,10 @@ await client.phoneNumbers.update({
```typescript -await client.tools.list(); +await client.campaigns.campaignControllerUpdate({ + id: "id", + body: {} +}); ```
@@ -1874,7 +2154,7 @@ await client.tools.list();
-**request:** `Vapi.ListToolsRequest` +**request:** `Vapi.CampaignControllerUpdateRequest`
@@ -1882,7 +2162,7 @@ await client.tools.list();
-**requestOptions:** `ToolsClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1894,7 +2174,7 @@ await client.tools.list();
-
client.tools.create({ ...params }) -> Vapi.CreateToolsResponse +
client.campaigns.campaignControllerGetCampaignV2Contacts({ ...params }) -> Vapi.CampaignContactPaginatedResponse
@@ -1907,10 +2187,8 @@ await client.tools.list();
```typescript -await client.tools.create({ - type: "apiRequest", - method: "POST", - url: "url" +await client.campaigns.campaignControllerGetCampaignV2Contacts({ + id: "id" }); ``` @@ -1927,7 +2205,7 @@ await client.tools.create({
-**request:** `Vapi.CreateToolsRequest` +**request:** `Vapi.CampaignControllerGetCampaignV2ContactsRequest`
@@ -1935,7 +2213,7 @@ await client.tools.create({
-**requestOptions:** `ToolsClient.RequestOptions` +**requestOptions:** `CampaignsClient.RequestOptions`
@@ -1947,7 +2225,8 @@ await client.tools.create({
-
client.tools.get({ ...params }) -> Vapi.GetToolsResponse +## Sessions +
client.sessions.list({ ...params }) -> Vapi.SessionPaginatedResponse
@@ -1960,8 +2239,9 @@ await client.tools.create({
```typescript -await client.tools.get({ - id: "id" +await client.sessions.list({ + assistantIdAny: "assistant-1,assistant-2,assistant-3", + customerNumberAny: "+1234567890,+0987654321" }); ``` @@ -1978,7 +2258,7 @@ await client.tools.get({
-**request:** `Vapi.GetToolsRequest` +**request:** `Vapi.ListSessionsRequest`
@@ -1986,7 +2266,7 @@ await client.tools.get({
-**requestOptions:** `ToolsClient.RequestOptions` +**requestOptions:** `SessionsClient.RequestOptions`
@@ -1998,7 +2278,7 @@ await client.tools.get({
-
client.tools.delete({ ...params }) -> Vapi.DeleteToolsResponse +
client.sessions.create({ ...params }) -> Vapi.Session
@@ -2011,9 +2291,7 @@ await client.tools.get({
```typescript -await client.tools.delete({ - id: "id" -}); +await client.sessions.create(); ```
@@ -2029,7 +2307,7 @@ await client.tools.delete({
-**request:** `Vapi.DeleteToolsRequest` +**request:** `Vapi.CreateSessionDto`
@@ -2037,7 +2315,7 @@ await client.tools.delete({
-**requestOptions:** `ToolsClient.RequestOptions` +**requestOptions:** `SessionsClient.RequestOptions`
@@ -2049,7 +2327,7 @@ await client.tools.delete({
-
client.tools.update({ ...params }) -> Vapi.UpdateToolsResponse +
client.sessions.get({ ...params }) -> Vapi.Session
@@ -2062,10 +2340,2797 @@ await client.tools.delete({
```typescript -await client.tools.update({ - id: "id", - body: { - type: "apiRequest" +await client.sessions.get({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.GetSessionsRequest` + +
+
+ +
+
+ +**requestOptions:** `SessionsClient.RequestOptions` + +
+
+
+
+ + +
+
+ + +
client.sessions.delete({ ...params }) -> Vapi.Session +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sessions.delete({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.DeleteSessionsRequest` + +
+
+ +
+
+ +**requestOptions:** `SessionsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.sessions.update({ ...params }) -> Vapi.Session +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.sessions.update({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateSessionDto` + +
+
+ +
+
+ +**requestOptions:** `SessionsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## PhoneNumbers +
client.phoneNumbers.list({ ...params }) -> Vapi.ListPhoneNumbersResponseItem[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.list(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ListPhoneNumbersRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.phoneNumbers.create({ ...params }) -> Vapi.CreatePhoneNumbersResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.create({ + provider: "byo-phone-number", + credentialId: "credentialId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreatePhoneNumbersRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.phoneNumbers.phoneNumberControllerFindAllPaginated({ ...params }) -> Vapi.PhoneNumberPaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.phoneNumberControllerFindAllPaginated(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.PhoneNumberControllerFindAllPaginatedRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.phoneNumbers.get({ ...params }) -> Vapi.GetPhoneNumbersResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the phone number resource identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.get({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.GetPhoneNumbersRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.phoneNumbers.delete({ ...params }) -> Vapi.DeletePhoneNumbersResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the phone number resource identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.delete({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.DeletePhoneNumbersRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.phoneNumbers.update({ ...params }) -> Vapi.UpdatePhoneNumbersResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the phone number resource identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.phoneNumbers.update({ + id: "id", + body: { + provider: "byo-phone-number" + } +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdatePhoneNumbersRequest` + +
+
+ +
+
+ +**requestOptions:** `PhoneNumbersClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## Tools +
client.tools.list({ ...params }) -> Vapi.ListToolsResponseItem[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.tools.list(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ListToolsRequest` + +
+
+ +
+
+ +**requestOptions:** `ToolsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.tools.create({ ...params }) -> Vapi.CreateToolsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a reusable tool that assistants can invoke during conversations. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.tools.create({ + type: "apiRequest", + method: "POST", + url: "url" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateToolsRequest` + +
+
+ +
+
+ +**requestOptions:** `ToolsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.tools.get({ ...params }) -> Vapi.GetToolsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the tool identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.tools.get({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.GetToolsRequest` + +
+
+ +
+
+ +**requestOptions:** `ToolsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.tools.delete({ ...params }) -> Vapi.DeleteToolsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the tool identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.tools.delete({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.DeleteToolsRequest` + +
+
+ +
+
+ +**requestOptions:** `ToolsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.tools.update({ ...params }) -> Vapi.UpdateToolsResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the tool identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.tools.update({ + id: "id", + body: { + type: "apiRequest" + } +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateToolsRequest` + +
+
+ +
+
+ +**requestOptions:** `ToolsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## Files +
client.files.list({ ...params }) -> Vapi.File_[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns files uploaded to the authenticated organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.files.list({ + purpose: "purpose" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ListFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `FilesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.files.create({ ...params }) -> Vapi.File_ +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Uploads a file for use with a Vapi knowledge base. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.files.create({ + file: fs.createReadStream("/path/to/your/file") +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateFileDto` + +
+
+ +
+
+ +**requestOptions:** `FilesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.files.get({ ...params }) -> Vapi.File_ +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the uploaded file identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.files.get({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.GetFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `FilesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.files.delete({ ...params }) -> Vapi.File_ +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the uploaded file identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.files.delete({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.DeleteFilesRequest` + +
+
+ +
+
+ +**requestOptions:** `FilesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.files.update({ ...params }) -> Vapi.File_ +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the name of the uploaded file identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.files.update({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateFileDto` + +
+
+ +
+
+ +**requestOptions:** `FilesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## KnowledgeBasesV2 +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFindAll({ ...params }) -> Vapi.KnowledgeBaseV2[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerCreate({ ...params }) -> Vapi.KnowledgeBaseV2 +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerCreate({ + name: "name" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateKnowledgeBaseV2Dto` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFilesGet({ ...params }) -> Vapi.KnowledgeBaseV2File[] +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFilesGet({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerFilesGetRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFileAttach({ ...params }) -> Vapi.KnowledgeBaseV2File +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileAttach({ + id: "id", + fileId: "fileId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.AttachKnowledgeBaseV2FileDto` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFileDetach({ ...params }) -> Vapi.KnowledgeBaseV2File +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileDetach({ + id: "id", + fileId: "fileId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerFileDetachRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFileRetry({ ...params }) -> Vapi.KnowledgeBaseV2File +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileRetry({ + id: "id", + fileId: "fileId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerFileRetryRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerFindOne({ ...params }) -> Vapi.KnowledgeBaseV2WithFiles +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerRemove({ ...params }) -> Vapi.KnowledgeBaseV2 +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerRemove({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.KnowledgeBaseV2ControllerRemoveRequest` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.knowledgeBasesV2.knowledgeBaseV2ControllerUpdate({ ...params }) -> Vapi.KnowledgeBaseV2 +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.knowledgeBasesV2.knowledgeBaseV2ControllerUpdate({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateKnowledgeBaseV2Dto` + +
+
+ +
+
+ +**requestOptions:** `KnowledgeBasesV2Client.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## StructuredOutputs +
client.structuredOutputs.structuredOutputControllerFindAll({ ...params }) -> Vapi.StructuredOutputPaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.StructuredOutputControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.structuredOutputs.structuredOutputControllerCreate({ ...params }) -> Vapi.StructuredOutput +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerCreate({ + name: "name", + schema: { + type: "string" + } +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateStructuredOutputDto` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.structuredOutputs.structuredOutputControllerFindOne({ ...params }) -> Vapi.StructuredOutput +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the structured-output definition identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.StructuredOutputControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.structuredOutputs.structuredOutputControllerRemove({ ...params }) -> Vapi.StructuredOutput +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the structured-output definition identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerRemove({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.StructuredOutputControllerRemoveRequest` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.structuredOutputs.structuredOutputControllerUpdate({ ...params }) -> Vapi.StructuredOutput +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the structured-output definition identified by its ID. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerUpdate({ + id: "id", + schemaOverride: "schemaOverride" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateStructuredOutputDto` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.structuredOutputs.structuredOutputControllerRun({ ...params }) -> Vapi.StructuredOutputControllerRunResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.structuredOutputs.structuredOutputControllerRun({ + callIds: ["callIds"] +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.StructuredOutputRunDto` + +
+
+ +
+
+ +**requestOptions:** `StructuredOutputsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## SimulationPersonalities +
client.simulationPersonalities.personalityControllerFindAll({ ...params }) -> Vapi.Personality[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the personalities for the authenticated organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationPersonalities.personalityControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.PersonalityControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationPersonalitiesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationPersonalities.personalityControllerCreate({ ...params }) -> Vapi.Personality +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a personality, the AI tester's configuration used in simulations. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationPersonalities.personalityControllerCreate({ + name: "name", + assistant: {} +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreatePersonalityDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationPersonalitiesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationPersonalities.personalityControllerFindOne({ ...params }) -> Vapi.Personality +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the specified personality. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationPersonalities.personalityControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.PersonalityControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationPersonalitiesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationPersonalities.personalityControllerRemove({ ...params }) -> Vapi.Personality +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the specified personality. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationPersonalities.personalityControllerRemove({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.PersonalityControllerRemoveRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationPersonalitiesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationPersonalities.personalityControllerUpdate({ ...params }) -> Vapi.Personality +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the specified personality. Changes apply to future runs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationPersonalities.personalityControllerUpdate({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdatePersonalityDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationPersonalitiesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## SimulationScenarios +
client.simulationScenarios.scenarioControllerFindAll({ ...params }) -> Vapi.Scenario[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the scenarios for the authenticated organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationScenarios.scenarioControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ScenarioControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationScenariosClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationScenarios.scenarioControllerCreate({ ...params }) -> Vapi.Scenario +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a scenario, the AI tester's intent plus the success criteria that score a run. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationScenarios.scenarioControllerCreate({ + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [{ + comparator: "=", + value: 1.1 + }] +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateScenarioDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationScenariosClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationScenarios.scenarioControllerFindOne({ ...params }) -> Vapi.Scenario +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the specified scenario. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationScenarios.scenarioControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ScenarioControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationScenariosClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationScenarios.scenarioControllerRemove({ ...params }) -> Vapi.Scenario +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the specified scenario. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationScenarios.scenarioControllerRemove({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.ScenarioControllerRemoveRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationScenariosClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationScenarios.scenarioControllerUpdate({ ...params }) -> Vapi.Scenario +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the specified scenario. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationScenarios.scenarioControllerUpdate({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateScenarioDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationScenariosClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## SimulationRuns +
client.simulationRuns.simulationRunControllerFindAll({ ...params }) -> Vapi.SimulationRunControllerFindAllResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the simulation runs for the authenticated organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerCreate({ ...params }) -> Vapi.CreateSimulationRunResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Starts a simulation run against a target assistant or squad. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerCreate({ + simulations: [{ + type: "simulation" + }], + target: { + type: "assistant" } }); @@ -2083,7 +5148,726 @@ await client.tools.update({
-**request:** `Vapi.UpdateToolsRequest` +**request:** `Vapi.CreateSimulationRunDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerFindOne({ ...params }) -> Vapi.SimulationRun +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the specified simulation run, including its status and item counts. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerCancelGroup({ ...params }) -> Vapi.SimulationRun +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels the specified simulation run. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerCancelGroup({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerCancelGroupRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerFindItems({ ...params }) -> Vapi.SimulationRunItem[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the run items for the specified simulation run. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerFindItems({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerFindItemsRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerFindItem({ ...params }) -> Vapi.SimulationRunItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the specified run item, including its evaluation results and the ID of the call that ran it. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerFindItem({ + id: "id", + itemId: "itemId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerFindItemRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerCancelItem({ ...params }) -> Vapi.SimulationRunItem +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Cancels the specified run item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerCancelItem({ + id: "id", + itemId: "itemId" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerCancelItemRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationRuns.simulationRunControllerGenerateSuggestions({ ...params }) -> void +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Generates AI suggestions for improving the assistant or squad's system prompt, tools, and scenarios, based on the specified run item. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationRuns.simulationRunControllerGenerateSuggestions({ + id: "id", + itemId: "itemId", + force: "force" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationRunControllerGenerateSuggestionsRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationRunsClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +## SimulationSuites +
client.simulationSuites.simulationSuiteControllerFindAll({ ...params }) -> Vapi.SimulationSuite[] +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the simulation suites for the authenticated organization. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationSuites.simulationSuiteControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationSuiteControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationSuitesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationSuites.simulationSuiteControllerCreate({ ...params }) -> Vapi.SimulationSuite +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a simulation suite, a group of simulations that run together. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationSuites.simulationSuiteControllerCreate({ + name: "Checkout Flow Tests", + simulationIds: ["simulationIds"] +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.CreateSimulationSuiteDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationSuitesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationSuites.simulationSuiteControllerFindOne({ ...params }) -> Vapi.SimulationSuite +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the specified simulation suite. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationSuites.simulationSuiteControllerFindOne({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationSuiteControllerFindOneRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationSuitesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationSuites.simulationSuiteControllerRemove({ ...params }) -> Vapi.SimulationSuite +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Deletes the specified simulation suite. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationSuites.simulationSuiteControllerRemove({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationSuiteControllerRemoveRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationSuitesClient.RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.simulationSuites.simulationSuiteControllerUpdate({ ...params }) -> Vapi.SimulationSuite +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Updates the specified simulation suite. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulationSuites.simulationSuiteControllerUpdate({ + id: "id" +}); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.UpdateSimulationSuiteDto`
@@ -2091,7 +5875,7 @@ await client.tools.update({
-**requestOptions:** `ToolsClient.RequestOptions` +**requestOptions:** `SimulationSuitesClient.RequestOptions`
@@ -2103,11 +5887,25 @@ await client.tools.update({
-## Files -
client.files.list() -> Vapi.File_[] +## Simulations +
client.simulations.simulationGenerateControllerGenerate({ ...params }) -> Vapi.GenerateScenariosResponse +
+
+ +#### 📝 Description +
+
+
+ +Generates scenarios for an assistant or squad by analyzing its configuration with AI. +
+
+
+
+ #### 🔌 Usage
@@ -2117,7 +5915,7 @@ await client.tools.update({
```typescript -await client.files.list(); +await client.simulations.simulationGenerateControllerGenerate(); ```
@@ -2133,7 +5931,15 @@ await client.files.list();
-**requestOptions:** `FilesClient.RequestOptions` +**request:** `Vapi.GenerateScenariosDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationsClient.RequestOptions`
@@ -2145,10 +5951,24 @@ await client.files.list();
-
client.files.create({ ...params }) -> Vapi.File_ +
client.simulations.simulationControllerFindAll({ ...params }) -> Vapi.Simulation[] +
+
+ +#### 📝 Description + +
+
+
+Returns the simulations for the authenticated organization. +
+
+
+
+ #### 🔌 Usage
@@ -2158,8 +5978,72 @@ await client.files.list();
```typescript -await client.files.create({ - file: fs.createReadStream("/path/to/your/file") +await client.simulations.simulationControllerFindAll(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `Vapi.SimulationControllerFindAllRequest` + +
+
+ +
+
+ +**requestOptions:** `SimulationsClient.RequestOptions` + +
+
+
+
+ + +
+
+ + +
client.simulations.simulationControllerCreate({ ...params }) -> Vapi.Simulation +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Creates a simulation by pairing a scenario with a personality. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulations.simulationControllerCreate({ + scenarioId: "scenarioId", + personalityId: "personalityId" }); ``` @@ -2176,7 +6060,7 @@ await client.files.create({
-**request:** `Vapi.CreateFileDto` +**request:** `Vapi.CreateSimulationDto`
@@ -2184,7 +6068,7 @@ await client.files.create({
-**requestOptions:** `FilesClient.RequestOptions` +**requestOptions:** `SimulationsClient.RequestOptions`
@@ -2196,10 +6080,24 @@ await client.files.create({
-
client.files.get({ ...params }) -> Vapi.File_ +
client.simulations.simulationControllerFindOne({ ...params }) -> Vapi.Simulation +
+
+ +#### 📝 Description + +
+
+
+Returns the specified simulation. +
+
+
+
+ #### 🔌 Usage
@@ -2209,7 +6107,7 @@ await client.files.create({
```typescript -await client.files.get({ +await client.simulations.simulationControllerFindOne({ id: "id" }); @@ -2227,7 +6125,7 @@ await client.files.get({
-**request:** `Vapi.GetFilesRequest` +**request:** `Vapi.SimulationControllerFindOneRequest`
@@ -2235,7 +6133,7 @@ await client.files.get({
-**requestOptions:** `FilesClient.RequestOptions` +**requestOptions:** `SimulationsClient.RequestOptions`
@@ -2247,10 +6145,24 @@ await client.files.get({
-
client.files.delete({ ...params }) -> Vapi.File_ +
client.simulations.simulationControllerRemove({ ...params }) -> Vapi.Simulation +
+
+ +#### 📝 Description + +
+
+
+Deletes the specified simulation. +
+
+
+
+ #### 🔌 Usage
@@ -2260,7 +6172,7 @@ await client.files.get({
```typescript -await client.files.delete({ +await client.simulations.simulationControllerRemove({ id: "id" }); @@ -2278,7 +6190,7 @@ await client.files.delete({
-**request:** `Vapi.DeleteFilesRequest` +**request:** `Vapi.SimulationControllerRemoveRequest`
@@ -2286,7 +6198,7 @@ await client.files.delete({
-**requestOptions:** `FilesClient.RequestOptions` +**requestOptions:** `SimulationsClient.RequestOptions`
@@ -2298,10 +6210,24 @@ await client.files.delete({
-
client.files.update({ ...params }) -> Vapi.File_ +
client.simulations.simulationControllerUpdate({ ...params }) -> Vapi.Simulation +
+
+ +#### 📝 Description +
+
+
+ +Updates the specified simulation. +
+
+
+
+ #### 🔌 Usage
@@ -2311,7 +6237,7 @@ await client.files.delete({
```typescript -await client.files.update({ +await client.simulations.simulationControllerUpdate({ id: "id" }); @@ -2329,15 +6255,70 @@ await client.files.update({
-**request:** `Vapi.UpdateFileDto` - -
-
- +**request:** `Vapi.UpdateSimulationDto` + +
+
+ +
+
+ +**requestOptions:** `SimulationsClient.RequestOptions` + +
+
+
+
+ + +
+
+ + +
client.simulations.simulationControllerGetConcurrency() -> Vapi.SimulationConcurrencyResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns the organization's simulation concurrency limit, the number of active simulations, and how many more can start. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```typescript +await client.simulations.simulationControllerGetConcurrency(); + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+
-**requestOptions:** `FilesClient.RequestOptions` +**requestOptions:** `SimulationsClient.RequestOptions`
@@ -2349,11 +6330,25 @@ await client.files.update({
-## StructuredOutputs -
client.structuredOutputs.structuredOutputControllerFindAll({ ...params }) -> Vapi.StructuredOutputPaginatedResponse +## Insight +
client.insight.insightControllerFindAll({ ...params }) -> Vapi.InsightPaginatedResponse +
+
+ +#### 📝 Description + +
+
+
+Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -2363,7 +6358,7 @@ await client.files.update({
```typescript -await client.structuredOutputs.structuredOutputControllerFindAll(); +await client.insight.insightControllerFindAll(); ```
@@ -2379,7 +6374,7 @@ await client.structuredOutputs.structuredOutputControllerFindAll();
-**request:** `Vapi.StructuredOutputControllerFindAllRequest` +**request:** `Vapi.InsightControllerFindAllRequest`
@@ -2387,7 +6382,7 @@ await client.structuredOutputs.structuredOutputControllerFindAll();
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2399,10 +6394,24 @@ await client.structuredOutputs.structuredOutputControllerFindAll();
-
client.structuredOutputs.structuredOutputControllerCreate({ ...params }) -> Vapi.StructuredOutput +
client.insight.insightControllerCreate({ ...params }) -> Vapi.InsightControllerCreateResponse +
+
+ +#### 📝 Description +
+
+
+ +Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. +
+
+
+
+ #### 🔌 Usage
@@ -2412,11 +6421,14 @@ await client.structuredOutputs.structuredOutputControllerFindAll();
```typescript -await client.structuredOutputs.structuredOutputControllerCreate({ - name: "name", - schema: { - type: "string" - } +await client.insight.insightControllerCreate({ + type: "bar", + queries: [{ + type: "vapiql-json", + table: "call", + column: "id", + operation: "count" + }] }); ``` @@ -2433,7 +6445,7 @@ await client.structuredOutputs.structuredOutputControllerCreate({
-**request:** `Vapi.CreateStructuredOutputDto` +**request:** `Vapi.InsightControllerCreateRequest`
@@ -2441,7 +6453,7 @@ await client.structuredOutputs.structuredOutputControllerCreate({
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2453,10 +6465,24 @@ await client.structuredOutputs.structuredOutputControllerCreate({
-
client.structuredOutputs.structuredOutputControllerFindOne({ ...params }) -> Vapi.StructuredOutput +
client.insight.insightControllerFindOne({ ...params }) -> Vapi.InsightControllerFindOneResponse +
+
+ +#### 📝 Description +
+
+
+ +Returns the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2466,7 +6492,7 @@ await client.structuredOutputs.structuredOutputControllerCreate({
```typescript -await client.structuredOutputs.structuredOutputControllerFindOne({ +await client.insight.insightControllerFindOne({ id: "id" }); @@ -2484,7 +6510,7 @@ await client.structuredOutputs.structuredOutputControllerFindOne({
-**request:** `Vapi.StructuredOutputControllerFindOneRequest` +**request:** `Vapi.InsightControllerFindOneRequest`
@@ -2492,7 +6518,7 @@ await client.structuredOutputs.structuredOutputControllerFindOne({
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2504,10 +6530,24 @@ await client.structuredOutputs.structuredOutputControllerFindOne({
-
client.structuredOutputs.structuredOutputControllerRemove({ ...params }) -> Vapi.StructuredOutput +
client.insight.insightControllerRemove({ ...params }) -> Vapi.InsightControllerRemoveResponse +
+
+ +#### 📝 Description + +
+
+
+Deletes the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2517,7 +6557,7 @@ await client.structuredOutputs.structuredOutputControllerFindOne({
```typescript -await client.structuredOutputs.structuredOutputControllerRemove({ +await client.insight.insightControllerRemove({ id: "id" }); @@ -2535,7 +6575,7 @@ await client.structuredOutputs.structuredOutputControllerRemove({
-**request:** `Vapi.StructuredOutputControllerRemoveRequest` +**request:** `Vapi.InsightControllerRemoveRequest`
@@ -2543,7 +6583,7 @@ await client.structuredOutputs.structuredOutputControllerRemove({
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2555,10 +6595,24 @@ await client.structuredOutputs.structuredOutputControllerRemove({
-
client.structuredOutputs.structuredOutputControllerUpdate({ ...params }) -> Vapi.StructuredOutput +
client.insight.insightControllerUpdate({ ...params }) -> Vapi.InsightControllerUpdateResponse +
+
+ +#### 📝 Description + +
+
+
+Updates the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2568,9 +6622,11 @@ await client.structuredOutputs.structuredOutputControllerRemove({
```typescript -await client.structuredOutputs.structuredOutputControllerUpdate({ +await client.insight.insightControllerUpdate({ id: "id", - schemaOverride: "schemaOverride" + body: { + type: "bar" + } }); ``` @@ -2587,7 +6643,7 @@ await client.structuredOutputs.structuredOutputControllerUpdate({
-**request:** `Vapi.UpdateStructuredOutputDto` +**request:** `Vapi.InsightControllerUpdateRequest`
@@ -2595,7 +6651,7 @@ await client.structuredOutputs.structuredOutputControllerUpdate({
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2607,10 +6663,24 @@ await client.structuredOutputs.structuredOutputControllerUpdate({
-
client.structuredOutputs.structuredOutputControllerRun({ ...params }) -> Vapi.StructuredOutput +
client.insight.insightControllerRun({ ...params }) -> Vapi.InsightRunResponse +
+
+ +#### 📝 Description + +
+
+
+Runs a saved reporting insight, optionally overriding its time range and response format. +
+
+
+
+ #### 🔌 Usage
@@ -2620,8 +6690,8 @@ await client.structuredOutputs.structuredOutputControllerUpdate({
```typescript -await client.structuredOutputs.structuredOutputControllerRun({ - callIds: ["callIds"] +await client.insight.insightControllerRun({ + id: "id" }); ``` @@ -2638,7 +6708,7 @@ await client.structuredOutputs.structuredOutputControllerRun({
-**request:** `Vapi.StructuredOutputRunDto` +**request:** `Vapi.InsightRunDto`
@@ -2646,7 +6716,7 @@ await client.structuredOutputs.structuredOutputControllerRun({
-**requestOptions:** `StructuredOutputsClient.RequestOptions` +**requestOptions:** `InsightClient.RequestOptions`
@@ -2658,11 +6728,24 @@ await client.structuredOutputs.structuredOutputControllerRun({
-## Insight -
client.insight.insightControllerFindAll({ ...params }) -> Vapi.InsightPaginatedResponse +
client.insight.insightControllerPreview({ ...params }) -> Vapi.InsightRunResponse +
+
+ +#### 📝 Description + +
+
+
+Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. +
+
+
+
+ #### 🔌 Usage
@@ -2672,7 +6755,15 @@ await client.structuredOutputs.structuredOutputControllerRun({
```typescript -await client.insight.insightControllerFindAll(); +await client.insight.insightControllerPreview({ + type: "bar", + queries: [{ + type: "vapiql-json", + table: "call", + column: "id", + operation: "count" + }] +}); ```
@@ -2688,7 +6779,7 @@ await client.insight.insightControllerFindAll();
-**request:** `Vapi.InsightControllerFindAllRequest` +**request:** `Vapi.InsightControllerPreviewRequest`
@@ -2708,7 +6799,8 @@ await client.insight.insightControllerFindAll();
-
client.insight.insightControllerCreate({ ...params }) -> Vapi.InsightControllerCreateResponse +## Board +
client.board.boardControllerFindAll({ ...params }) -> Vapi.BoardPaginatedResponse
@@ -2721,15 +6813,7 @@ await client.insight.insightControllerFindAll();
```typescript -await client.insight.insightControllerCreate({ - type: "bar", - queries: [{ - type: "vapiql-json", - table: "call", - column: "id", - operation: "count" - }] -}); +await client.board.boardControllerFindAll(); ```
@@ -2745,7 +6829,7 @@ await client.insight.insightControllerCreate({
-**request:** `Vapi.InsightControllerCreateRequest` +**request:** `Vapi.BoardControllerFindAllRequest`
@@ -2753,7 +6837,7 @@ await client.insight.insightControllerCreate({
-**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
@@ -2765,7 +6849,7 @@ await client.insight.insightControllerCreate({
-
client.insight.insightControllerFindOne({ ...params }) -> Vapi.InsightControllerFindOneResponse +
client.board.boardControllerCreate({ ...params }) -> Vapi.Board
@@ -2778,8 +6862,11 @@ await client.insight.insightControllerCreate({
```typescript -await client.insight.insightControllerFindOne({ - id: "id" +await client.board.boardControllerCreate({ + name: "name", + layout: { + columns: 1.1 + } }); ``` @@ -2796,7 +6883,7 @@ await client.insight.insightControllerFindOne({
-**request:** `Vapi.InsightControllerFindOneRequest` +**request:** `Vapi.CreateBoardDto`
@@ -2804,7 +6891,7 @@ await client.insight.insightControllerFindOne({
-**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
@@ -2816,7 +6903,7 @@ await client.insight.insightControllerFindOne({
-
client.insight.insightControllerRemove({ ...params }) -> Vapi.InsightControllerRemoveResponse +
client.board.boardControllerMetricsOverviewEnsure() -> Vapi.Board
@@ -2829,9 +6916,7 @@ await client.insight.insightControllerFindOne({
```typescript -await client.insight.insightControllerRemove({ - id: "id" -}); +await client.board.boardControllerMetricsOverviewEnsure(); ```
@@ -2847,15 +6932,7 @@ await client.insight.insightControllerRemove({
-**request:** `Vapi.InsightControllerRemoveRequest` - -
-
- -
-
- -**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
@@ -2867,7 +6944,7 @@ await client.insight.insightControllerRemove({
-
client.insight.insightControllerUpdate({ ...params }) -> Vapi.InsightControllerUpdateResponse +
client.board.boardControllerFindOne({ ...params }) -> Vapi.Board
@@ -2880,11 +6957,8 @@ await client.insight.insightControllerRemove({
```typescript -await client.insight.insightControllerUpdate({ - id: "id", - body: { - type: "bar" - } +await client.board.boardControllerFindOne({ + id: "id" }); ``` @@ -2901,7 +6975,7 @@ await client.insight.insightControllerUpdate({
-**request:** `Vapi.InsightControllerUpdateRequest` +**request:** `Vapi.BoardControllerFindOneRequest`
@@ -2909,7 +6983,7 @@ await client.insight.insightControllerUpdate({
-**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
@@ -2921,7 +6995,7 @@ await client.insight.insightControllerUpdate({
-
client.insight.insightControllerRun({ ...params }) -> Vapi.InsightRunResponse +
client.board.boardControllerRemove({ ...params }) -> Vapi.Board
@@ -2934,7 +7008,7 @@ await client.insight.insightControllerUpdate({
```typescript -await client.insight.insightControllerRun({ +await client.board.boardControllerRemove({ id: "id" }); @@ -2952,7 +7026,7 @@ await client.insight.insightControllerRun({
-**request:** `Vapi.InsightRunDto` +**request:** `Vapi.BoardControllerRemoveRequest`
@@ -2960,7 +7034,7 @@ await client.insight.insightControllerRun({
-**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
@@ -2972,7 +7046,7 @@ await client.insight.insightControllerRun({
-
client.insight.insightControllerPreview({ ...params }) -> Vapi.InsightRunResponse +
client.board.boardControllerUpdate({ ...params }) -> Vapi.Board
@@ -2985,14 +7059,8 @@ await client.insight.insightControllerRun({
```typescript -await client.insight.insightControllerPreview({ - type: "bar", - queries: [{ - type: "vapiql-json", - table: "call", - column: "id", - operation: "count" - }] +await client.board.boardControllerUpdate({ + id: "id" }); ``` @@ -3009,7 +7077,7 @@ await client.insight.insightControllerPreview({
-**request:** `Vapi.InsightControllerPreviewRequest` +**request:** `Vapi.UpdateBoardDto`
@@ -3017,22 +7085,36 @@ await client.insight.insightControllerPreview({
-**requestOptions:** `InsightClient.RequestOptions` +**requestOptions:** `BoardClient.RequestOptions`
- - + + +
+
+ + +## Eval +
client.eval.evalControllerGetPaginated({ ...params }) -> Vapi.EvalPaginatedResponse +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
-
- -## Eval -
client.eval.evalControllerGetPaginated({ ...params }) -> Vapi.EvalPaginatedResponse -
-
#### 🔌 Usage @@ -3083,6 +7165,20 @@ await client.eval.evalControllerGetPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. +
+
+
+
+ #### 🔌 Usage
@@ -3137,6 +7233,20 @@ await client.eval.evalControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3188,6 +7298,20 @@ await client.eval.evalControllerGet({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3239,6 +7363,20 @@ await client.eval.evalControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3290,6 +7428,20 @@ await client.eval.evalControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3341,6 +7493,20 @@ await client.eval.evalControllerGetRun({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3392,6 +7558,20 @@ await client.eval.evalControllerRemoveRun({
+#### 📝 Description + +
+
+ +
+
+ +Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3441,6 +7621,20 @@ await client.eval.evalControllerGetRunsPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. +
+
+
+
+ #### 🔌 Usage
@@ -3496,6 +7690,20 @@ await client.eval.evalControllerRun({
+#### 📝 Description + +
+
+ +
+
+ +Returns the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3547,6 +7755,20 @@ await client.observabilityScorecard.scorecardControllerGet({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3598,6 +7820,20 @@ await client.observabilityScorecard.scorecardControllerRemove({
+#### 📝 Description + +
+
+ +
+
+ +Updates the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3649,6 +7885,20 @@ await client.observabilityScorecard.scorecardControllerUpdate({
+#### 📝 Description + +
+
+ +
+
+ +Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3698,6 +7948,20 @@ await client.observabilityScorecard.scorecardControllerGetPaginated();
+#### 📝 Description + +
+
+ +
+
+ +Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. +
+
+
+
+ #### 🔌 Usage
@@ -3709,10 +7973,13 @@ await client.observabilityScorecard.scorecardControllerGetPaginated(); ```typescript await client.observabilityScorecard.scorecardControllerCreate({ metrics: [{ - structuredOutputId: "structuredOutputId", conditions: [{ - "key": "value" - }] + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" }] }); @@ -3755,6 +8022,20 @@ await client.observabilityScorecard.scorecardControllerCreate({
+#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3807,6 +8088,20 @@ await client.providerResources.providerResourceControllerGetProviderResourcesPag
+#### 📝 Description + +
+
+ +
+
+ +Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. +
+
+
+
+ #### 🔌 Usage
@@ -3859,6 +8154,20 @@ await client.providerResources.providerResourceControllerCreateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Returns the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -3912,6 +8221,20 @@ await client.providerResources.providerResourceControllerGetProviderResource({
+#### 📝 Description + +
+
+ +
+
+ +Deletes the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -3965,6 +8288,20 @@ await client.providerResources.providerResourceControllerDeleteProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Updates the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -4019,6 +8356,20 @@ await client.providerResources.providerResourceControllerUpdateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. +
+
+
+
+ #### 🔌 Usage
diff --git a/src/BaseClient.ts b/src/BaseClient.ts index 98a48b9f..0cbc606c 100644 --- a/src/BaseClient.ts +++ b/src/BaseClient.ts @@ -52,8 +52,8 @@ export function normalizeClientOptions; @@ -154,5 +157,6 @@ export interface UpdateAssistantDto { * 3. org.serverUrl */ server?: Vapi.Server; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan; } diff --git a/src/api/resources/assistants/types/UpdateAssistantDtoCredentialsItem.ts b/src/api/resources/assistants/types/UpdateAssistantDtoCredentialsItem.ts index 858975fa..32cfa33b 100644 --- a/src/api/resources/assistants/types/UpdateAssistantDtoCredentialsItem.ts +++ b/src/api/resources/assistants/types/UpdateAssistantDtoCredentialsItem.ts @@ -34,6 +34,7 @@ export type UpdateAssistantDtoCredentialsItem = | Vapi.UpdateAssistantDtoCredentialsItem.RimeAi | Vapi.UpdateAssistantDtoCredentialsItem.Runpod | Vapi.UpdateAssistantDtoCredentialsItem.S3 + | Vapi.UpdateAssistantDtoCredentialsItem.S3Compatible | Vapi.UpdateAssistantDtoCredentialsItem.Supabase | Vapi.UpdateAssistantDtoCredentialsItem.SmallestAi | Vapi.UpdateAssistantDtoCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type UpdateAssistantDtoCredentialsItem = | Vapi.UpdateAssistantDtoCredentialsItem.Webhook | Vapi.UpdateAssistantDtoCredentialsItem.CustomCredential | Vapi.UpdateAssistantDtoCredentialsItem.Xai + | Vapi.UpdateAssistantDtoCredentialsItem.Microsoft | Vapi.UpdateAssistantDtoCredentialsItem.Neuphonic | Vapi.UpdateAssistantDtoCredentialsItem.Hume | Vapi.UpdateAssistantDtoCredentialsItem.Mistral | Vapi.UpdateAssistantDtoCredentialsItem.Speechmatics | Vapi.UpdateAssistantDtoCredentialsItem.Soniox - | Vapi.UpdateAssistantDtoCredentialsItem.Trieve | Vapi.UpdateAssistantDtoCredentialsItem.GoogleCalendarOauth2Client | Vapi.UpdateAssistantDtoCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.UpdateAssistantDtoCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace UpdateAssistantDtoCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace UpdateAssistantDtoCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace UpdateAssistantDtoCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace UpdateAssistantDtoCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.UpdateAssistantDtoCredentialsItem._11Labs + | Vapi.UpdateAssistantDtoCredentialsItem.Anthropic + | Vapi.UpdateAssistantDtoCredentialsItem.AnthropicBedrock + | Vapi.UpdateAssistantDtoCredentialsItem.Anyscale + | Vapi.UpdateAssistantDtoCredentialsItem.AssemblyAi + | Vapi.UpdateAssistantDtoCredentialsItem.AzureOpenai + | Vapi.UpdateAssistantDtoCredentialsItem.Azure + | Vapi.UpdateAssistantDtoCredentialsItem.ByoSipTrunk + | Vapi.UpdateAssistantDtoCredentialsItem.Cartesia + | Vapi.UpdateAssistantDtoCredentialsItem.Cerebras + | Vapi.UpdateAssistantDtoCredentialsItem.Cloudflare + | Vapi.UpdateAssistantDtoCredentialsItem.CustomLlm + | Vapi.UpdateAssistantDtoCredentialsItem.Deepgram + | Vapi.UpdateAssistantDtoCredentialsItem.Deepinfra + | Vapi.UpdateAssistantDtoCredentialsItem.DeepSeek + | Vapi.UpdateAssistantDtoCredentialsItem.Gcp + | Vapi.UpdateAssistantDtoCredentialsItem.Gladia + | Vapi.UpdateAssistantDtoCredentialsItem.Gohighlevel + | Vapi.UpdateAssistantDtoCredentialsItem.Google + | Vapi.UpdateAssistantDtoCredentialsItem.Groq + | Vapi.UpdateAssistantDtoCredentialsItem.InflectionAi + | Vapi.UpdateAssistantDtoCredentialsItem.Langfuse + | Vapi.UpdateAssistantDtoCredentialsItem.Lmnt + | Vapi.UpdateAssistantDtoCredentialsItem.Make + | Vapi.UpdateAssistantDtoCredentialsItem.Openai + | Vapi.UpdateAssistantDtoCredentialsItem.Openrouter + | Vapi.UpdateAssistantDtoCredentialsItem.PerplexityAi + | Vapi.UpdateAssistantDtoCredentialsItem.Playht + | Vapi.UpdateAssistantDtoCredentialsItem.RimeAi + | Vapi.UpdateAssistantDtoCredentialsItem.Runpod + | Vapi.UpdateAssistantDtoCredentialsItem.S3 + | Vapi.UpdateAssistantDtoCredentialsItem.S3Compatible + | Vapi.UpdateAssistantDtoCredentialsItem.Supabase + | Vapi.UpdateAssistantDtoCredentialsItem.SmallestAi + | Vapi.UpdateAssistantDtoCredentialsItem.Tavus + | Vapi.UpdateAssistantDtoCredentialsItem.TogetherAi + | Vapi.UpdateAssistantDtoCredentialsItem.Twilio + | Vapi.UpdateAssistantDtoCredentialsItem.Vonage + | Vapi.UpdateAssistantDtoCredentialsItem.Webhook + | Vapi.UpdateAssistantDtoCredentialsItem.CustomCredential + | Vapi.UpdateAssistantDtoCredentialsItem.Xai + | Vapi.UpdateAssistantDtoCredentialsItem.Microsoft + | Vapi.UpdateAssistantDtoCredentialsItem.Neuphonic + | Vapi.UpdateAssistantDtoCredentialsItem.Hume + | Vapi.UpdateAssistantDtoCredentialsItem.Mistral + | Vapi.UpdateAssistantDtoCredentialsItem.Speechmatics + | Vapi.UpdateAssistantDtoCredentialsItem.Soniox + | Vapi.UpdateAssistantDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.UpdateAssistantDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.UpdateAssistantDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.UpdateAssistantDtoCredentialsItem.SlackOauth2Authorization + | Vapi.UpdateAssistantDtoCredentialsItem.GhlOauth2Authorization + | Vapi.UpdateAssistantDtoCredentialsItem.Inworld + | Vapi.UpdateAssistantDtoCredentialsItem.Minimax + | Vapi.UpdateAssistantDtoCredentialsItem.Wellsaid + | Vapi.UpdateAssistantDtoCredentialsItem.Email + | Vapi.UpdateAssistantDtoCredentialsItem.SlackWebhook; } diff --git a/src/api/resources/assistants/types/UpdateAssistantDtoModel.ts b/src/api/resources/assistants/types/UpdateAssistantDtoModel.ts index f6306249..a023c495 100644 --- a/src/api/resources/assistants/types/UpdateAssistantDtoModel.ts +++ b/src/api/resources/assistants/types/UpdateAssistantDtoModel.ts @@ -21,7 +21,8 @@ export type UpdateAssistantDtoModel = | Vapi.UpdateAssistantDtoModel.Openrouter | Vapi.UpdateAssistantDtoModel.PerplexityAi | Vapi.UpdateAssistantDtoModel.TogetherAi - | Vapi.UpdateAssistantDtoModel.Xai; + | Vapi.UpdateAssistantDtoModel.Xai + | Vapi.UpdateAssistantDtoModel.Vapi; export namespace UpdateAssistantDtoModel { export interface Anthropic extends Vapi.AnthropicModel { @@ -87,4 +88,30 @@ export namespace UpdateAssistantDtoModel { export interface Xai extends Vapi.XaiModel { provider: "xai"; } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.UpdateAssistantDtoModel.Anthropic + | Vapi.UpdateAssistantDtoModel.AnthropicBedrock + | Vapi.UpdateAssistantDtoModel.Anyscale + | Vapi.UpdateAssistantDtoModel.Cerebras + | Vapi.UpdateAssistantDtoModel.CustomLlm + | Vapi.UpdateAssistantDtoModel.Deepinfra + | Vapi.UpdateAssistantDtoModel.DeepSeek + | Vapi.UpdateAssistantDtoModel.Google + | Vapi.UpdateAssistantDtoModel.Groq + | Vapi.UpdateAssistantDtoModel.InflectionAi + | Vapi.UpdateAssistantDtoModel.Minimax + | Vapi.UpdateAssistantDtoModel.Openai + | Vapi.UpdateAssistantDtoModel.Openrouter + | Vapi.UpdateAssistantDtoModel.PerplexityAi + | Vapi.UpdateAssistantDtoModel.TogetherAi + | Vapi.UpdateAssistantDtoModel.Xai + | Vapi.UpdateAssistantDtoModel.Vapi; } diff --git a/src/api/resources/assistants/types/UpdateAssistantDtoServerMessagesItem.ts b/src/api/resources/assistants/types/UpdateAssistantDtoServerMessagesItem.ts index 1af5fefd..8f7de20b 100644 --- a/src/api/resources/assistants/types/UpdateAssistantDtoServerMessagesItem.ts +++ b/src/api/resources/assistants/types/UpdateAssistantDtoServerMessagesItem.ts @@ -28,6 +28,7 @@ export const UpdateAssistantDtoServerMessagesItem = { SessionDeleted: "session.deleted", CallDeleted: "call.deleted", CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", } as const; export type UpdateAssistantDtoServerMessagesItem = (typeof UpdateAssistantDtoServerMessagesItem)[keyof typeof UpdateAssistantDtoServerMessagesItem]; diff --git a/src/api/resources/assistants/types/UpdateAssistantDtoTranscriber.ts b/src/api/resources/assistants/types/UpdateAssistantDtoTranscriber.ts index 58c4fb17..a86f57f5 100644 --- a/src/api/resources/assistants/types/UpdateAssistantDtoTranscriber.ts +++ b/src/api/resources/assistants/types/UpdateAssistantDtoTranscriber.ts @@ -17,7 +17,9 @@ export type UpdateAssistantDtoTranscriber = | Vapi.UpdateAssistantDtoTranscriber.Talkscriber | Vapi.UpdateAssistantDtoTranscriber.Openai | Vapi.UpdateAssistantDtoTranscriber.Cartesia - | Vapi.UpdateAssistantDtoTranscriber.Soniox; + | Vapi.UpdateAssistantDtoTranscriber.Soniox + | Vapi.UpdateAssistantDtoTranscriber.Xai + | Vapi.UpdateAssistantDtoTranscriber.Vapi; export namespace UpdateAssistantDtoTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -67,4 +69,12 @@ export namespace UpdateAssistantDtoTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/resources/assistants/types/UpdateAssistantDtoVoice.ts b/src/api/resources/assistants/types/UpdateAssistantDtoVoice.ts index 9d7f747b..f3250958 100644 --- a/src/api/resources/assistants/types/UpdateAssistantDtoVoice.ts +++ b/src/api/resources/assistants/types/UpdateAssistantDtoVoice.ts @@ -23,7 +23,9 @@ export type UpdateAssistantDtoVoice = | Vapi.UpdateAssistantDtoVoice.Vapi | Vapi.UpdateAssistantDtoVoice.Sesame | Vapi.UpdateAssistantDtoVoice.Inworld - | Vapi.UpdateAssistantDtoVoice.Minimax; + | Vapi.UpdateAssistantDtoVoice.Minimax + | Vapi.UpdateAssistantDtoVoice.Xai + | Vapi.UpdateAssistantDtoVoice.Microsoft; export namespace UpdateAssistantDtoVoice { export interface Azure extends Vapi.AzureVoice { @@ -97,4 +99,12 @@ export namespace UpdateAssistantDtoVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/resources/board/client/Client.ts b/src/api/resources/board/client/Client.ts new file mode 100644 index 00000000..c78c5093 --- /dev/null +++ b/src/api/resources/board/client/Client.ts @@ -0,0 +1,404 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace BoardClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class BoardClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: BoardClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * @param {Vapi.BoardControllerFindAllRequest} request + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerFindAll() + */ + public boardControllerFindAll( + request: Vapi.BoardControllerFindAllRequest = {}, + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerFindAll(request, requestOptions)); + } + + private async __boardControllerFindAll( + request: Vapi.BoardControllerFindAllRequest = {}, + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const { + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "reporting/board", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.BoardPaginatedResponse, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/reporting/board"); + } + + /** + * @param {Vapi.CreateBoardDto} request + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerCreate({ + * name: "name", + * layout: { + * columns: 1.1 + * } + * }) + */ + public boardControllerCreate( + request: Vapi.CreateBoardDto, + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerCreate(request, requestOptions)); + } + + private async __boardControllerCreate( + request: Vapi.CreateBoardDto, + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "reporting/board", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Board, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/reporting/board"); + } + + /** + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerMetricsOverviewEnsure() + */ + public boardControllerMetricsOverviewEnsure( + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerMetricsOverviewEnsure(requestOptions)); + } + + private async __boardControllerMetricsOverviewEnsure( + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "reporting/board/default/metrics-overview", + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Board, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/reporting/board/default/metrics-overview", + ); + } + + /** + * @param {Vapi.BoardControllerFindOneRequest} request + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerFindOne({ + * id: "id" + * }) + */ + public boardControllerFindOne( + request: Vapi.BoardControllerFindOneRequest, + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerFindOne(request, requestOptions)); + } + + private async __boardControllerFindOne( + request: Vapi.BoardControllerFindOneRequest, + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `reporting/board/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Board, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/reporting/board/{id}"); + } + + /** + * @param {Vapi.BoardControllerRemoveRequest} request + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerRemove({ + * id: "id" + * }) + */ + public boardControllerRemove( + request: Vapi.BoardControllerRemoveRequest, + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerRemove(request, requestOptions)); + } + + private async __boardControllerRemove( + request: Vapi.BoardControllerRemoveRequest, + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `reporting/board/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Board, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/reporting/board/{id}"); + } + + /** + * @param {Vapi.UpdateBoardDto} request + * @param {BoardClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.board.boardControllerUpdate({ + * id: "id" + * }) + */ + public boardControllerUpdate( + request: Vapi.UpdateBoardDto, + requestOptions?: BoardClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__boardControllerUpdate(request, requestOptions)); + } + + private async __boardControllerUpdate( + request: Vapi.UpdateBoardDto, + requestOptions?: BoardClient.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `reporting/board/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Board, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/reporting/board/{id}"); + } +} diff --git a/src/api/resources/board/client/index.ts b/src/api/resources/board/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/board/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/resources/board/client/requests/BoardControllerFindAllRequest.ts b/src/api/resources/board/client/requests/BoardControllerFindAllRequest.ts new file mode 100644 index 00000000..2d3503db --- /dev/null +++ b/src/api/resources/board/client/requests/BoardControllerFindAllRequest.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface BoardControllerFindAllRequest { + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.BoardControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.BoardControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/board/client/requests/BoardControllerFindOneRequest.ts b/src/api/resources/board/client/requests/BoardControllerFindOneRequest.ts new file mode 100644 index 00000000..d7861c49 --- /dev/null +++ b/src/api/resources/board/client/requests/BoardControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface BoardControllerFindOneRequest { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/board/client/requests/BoardControllerRemoveRequest.ts b/src/api/resources/board/client/requests/BoardControllerRemoveRequest.ts new file mode 100644 index 00000000..3d08d8d0 --- /dev/null +++ b/src/api/resources/board/client/requests/BoardControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface BoardControllerRemoveRequest { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/board/client/requests/CreateBoardDto.ts b/src/api/resources/board/client/requests/CreateBoardDto.ts new file mode 100644 index 00000000..5ab1f598 --- /dev/null +++ b/src/api/resources/board/client/requests/CreateBoardDto.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * name: "name", + * layout: { + * columns: 1.1 + * } + * } + */ +export interface CreateBoardDto { + /** This is the contents of the Board, which is an array of objects defining the type, contents, and position of the widgets on the Board. */ + items?: Vapi.CreateBoardDtoItemsItem[]; + /** This is the name of the Board. */ + name: string; + /** This is the layout of the Board. */ + layout: Vapi.BoardLayout; + /** + * This is the timerange override for the board. + * By default, individual insights have their own timerange. + * This is a global override for the board which will be passed to all insights on the board. + */ + timeRangeOverride?: Vapi.InsightTimeRangeWithStep; +} diff --git a/src/api/resources/board/client/requests/UpdateBoardDto.ts b/src/api/resources/board/client/requests/UpdateBoardDto.ts new file mode 100644 index 00000000..79989395 --- /dev/null +++ b/src/api/resources/board/client/requests/UpdateBoardDto.ts @@ -0,0 +1,26 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id" + * } + */ +export interface UpdateBoardDto { + /** The unique identifier for the resource. */ + id: string; + /** This is the contents of the Board, which is an array of objects defining the type, contents, and position of the widgets on the Board. */ + items?: Vapi.UpdateBoardDtoItemsItem[]; + /** This is the name of the Board. */ + name?: string; + /** This is the layout of the Board. */ + layout?: Vapi.BoardLayout; + /** + * This is the timerange override for the board. + * By default, individual insights have their own timerange. + * This is a global override for the board which will be passed to all insights on the board. + */ + timeRangeOverride?: Vapi.InsightTimeRangeWithStep; +} diff --git a/src/api/resources/board/client/requests/index.ts b/src/api/resources/board/client/requests/index.ts new file mode 100644 index 00000000..401911f7 --- /dev/null +++ b/src/api/resources/board/client/requests/index.ts @@ -0,0 +1,5 @@ +export type { BoardControllerFindAllRequest } from "./BoardControllerFindAllRequest.js"; +export type { BoardControllerFindOneRequest } from "./BoardControllerFindOneRequest.js"; +export type { BoardControllerRemoveRequest } from "./BoardControllerRemoveRequest.js"; +export type { CreateBoardDto } from "./CreateBoardDto.js"; +export type { UpdateBoardDto } from "./UpdateBoardDto.js"; diff --git a/src/api/resources/board/exports.ts b/src/api/resources/board/exports.ts new file mode 100644 index 00000000..8ed48bcb --- /dev/null +++ b/src/api/resources/board/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { BoardClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/board/index.ts b/src/api/resources/board/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/board/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/board/types/BoardControllerFindAllRequestSortBy.ts b/src/api/resources/board/types/BoardControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..543acc96 --- /dev/null +++ b/src/api/resources/board/types/BoardControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const BoardControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type BoardControllerFindAllRequestSortBy = + (typeof BoardControllerFindAllRequestSortBy)[keyof typeof BoardControllerFindAllRequestSortBy]; diff --git a/src/api/resources/board/types/BoardControllerFindAllRequestSortOrder.ts b/src/api/resources/board/types/BoardControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..e785dbe3 --- /dev/null +++ b/src/api/resources/board/types/BoardControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const BoardControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type BoardControllerFindAllRequestSortOrder = + (typeof BoardControllerFindAllRequestSortOrder)[keyof typeof BoardControllerFindAllRequestSortOrder]; diff --git a/src/api/resources/board/types/CreateBoardDtoItemsItem.ts b/src/api/resources/board/types/CreateBoardDtoItemsItem.ts new file mode 100644 index 00000000..fae8869c --- /dev/null +++ b/src/api/resources/board/types/CreateBoardDtoItemsItem.ts @@ -0,0 +1,5 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export type CreateBoardDtoItemsItem = Vapi.BoardInsightItem | Vapi.BoardMetricWidgetItem; diff --git a/src/api/resources/board/types/UpdateBoardDtoItemsItem.ts b/src/api/resources/board/types/UpdateBoardDtoItemsItem.ts new file mode 100644 index 00000000..2617de53 --- /dev/null +++ b/src/api/resources/board/types/UpdateBoardDtoItemsItem.ts @@ -0,0 +1,5 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export type UpdateBoardDtoItemsItem = Vapi.BoardInsightItem | Vapi.BoardMetricWidgetItem; diff --git a/src/api/resources/board/types/index.ts b/src/api/resources/board/types/index.ts new file mode 100644 index 00000000..2a7d4145 --- /dev/null +++ b/src/api/resources/board/types/index.ts @@ -0,0 +1,4 @@ +export * from "./BoardControllerFindAllRequestSortBy.js"; +export * from "./BoardControllerFindAllRequestSortOrder.js"; +export * from "./CreateBoardDtoItemsItem.js"; +export * from "./UpdateBoardDtoItemsItem.js"; diff --git a/src/api/resources/calls/client/Client.ts b/src/api/resources/calls/client/Client.ts index 6c591af2..40f75782 100644 --- a/src/api/resources/calls/client/Client.ts +++ b/src/api/resources/calls/client/Client.ts @@ -7,7 +7,7 @@ import * as core from "../../../../core/index.js"; import * as environments from "../../../../environments.js"; import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; import * as errors from "../../../../errors/index.js"; -import type * as Vapi from "../../../index.js"; +import * as Vapi from "../../../index.js"; export declare namespace CallsClient { export type Options = BaseClientOptions; @@ -23,6 +23,8 @@ export class CallsClient { } /** + * Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. + * * @param {Vapi.ListCallsRequest} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -106,9 +108,14 @@ export class CallsClient { } /** + * Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. + * * @param {Vapi.CreateCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * + * @throws {@link Vapi.BadRequestError} + * @throws {@link Vapi.InternalServerError} + * * @example * await client.calls.create() */ @@ -153,17 +160,26 @@ export class CallsClient { } if (_response.error.reason === "status-code") { - throw new errors.VapiError({ - statusCode: _response.error.statusCode, - body: _response.error.body, - rawResponse: _response.rawResponse, - }); + switch (_response.error.statusCode) { + case 400: + throw new Vapi.BadRequestError(_response.error.body as unknown, _response.rawResponse); + case 500: + throw new Vapi.InternalServerError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } } return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/call"); } /** + * Returns the call identified by its ID, including its status, configuration, and available call data. + * * @param {Vapi.GetCallsRequest} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -222,9 +238,13 @@ export class CallsClient { } /** + * Deletes the call identified by its ID. + * * @param {Vapi.DeleteCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * + * @throws {@link Vapi.ServiceUnavailableError} + * * @example * await client.calls.delete({ * id: "id" @@ -272,17 +292,24 @@ export class CallsClient { } if (_response.error.reason === "status-code") { - throw new errors.VapiError({ - statusCode: _response.error.statusCode, - body: _response.error.body, - rawResponse: _response.rawResponse, - }); + switch (_response.error.statusCode) { + case 503: + throw new Vapi.ServiceUnavailableError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } } return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/call/{id}"); } /** + * Updates the call identified by its ID. + * * @param {Vapi.UpdateCallDto} request * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -342,4 +369,497 @@ export class CallsClient { return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/call/{id}"); } + + /** + * @param {Vapi.CallArtifactControllerMonoRecordingDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerMonoRecordingDownload({ + * id: "id" + * }) + */ + public callArtifactControllerMonoRecordingDownload( + request: Vapi.CallArtifactControllerMonoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerMonoRecordingDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerMonoRecordingDownload( + request: Vapi.CallArtifactControllerMonoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/mono-recording`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/mono-recording"); + } + + /** + * @param {Vapi.CallArtifactControllerStereoRecordingDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerStereoRecordingDownload({ + * id: "id" + * }) + */ + public callArtifactControllerStereoRecordingDownload( + request: Vapi.CallArtifactControllerStereoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerStereoRecordingDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerStereoRecordingDownload( + request: Vapi.CallArtifactControllerStereoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/stereo-recording`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/stereo-recording"); + } + + /** + * @param {Vapi.CallArtifactControllerVideoRecordingDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerVideoRecordingDownload({ + * id: "id" + * }) + */ + public callArtifactControllerVideoRecordingDownload( + request: Vapi.CallArtifactControllerVideoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerVideoRecordingDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerVideoRecordingDownload( + request: Vapi.CallArtifactControllerVideoRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/video-recording`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/video-recording"); + } + + /** + * @param {Vapi.CallArtifactControllerCustomerRecordingDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerCustomerRecordingDownload({ + * id: "id" + * }) + */ + public callArtifactControllerCustomerRecordingDownload( + request: Vapi.CallArtifactControllerCustomerRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerCustomerRecordingDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerCustomerRecordingDownload( + request: Vapi.CallArtifactControllerCustomerRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/customer-recording`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/customer-recording"); + } + + /** + * @param {Vapi.CallArtifactControllerAssistantRecordingDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerAssistantRecordingDownload({ + * id: "id" + * }) + */ + public callArtifactControllerAssistantRecordingDownload( + request: Vapi.CallArtifactControllerAssistantRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerAssistantRecordingDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerAssistantRecordingDownload( + request: Vapi.CallArtifactControllerAssistantRecordingDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/assistant-recording`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/call/{id}/assistant-recording", + ); + } + + /** + * @param {Vapi.CallArtifactControllerPcapDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerPcapDownload({ + * id: "id" + * }) + */ + public callArtifactControllerPcapDownload( + request: Vapi.CallArtifactControllerPcapDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__callArtifactControllerPcapDownload(request, requestOptions)); + } + + private async __callArtifactControllerPcapDownload( + request: Vapi.CallArtifactControllerPcapDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/pcap`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/pcap"); + } + + /** + * @param {Vapi.CallArtifactControllerCallLogsDownloadRequest} request + * @param {CallsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.UnauthorizedError} + * @throws {@link Vapi.NotFoundError} + * + * @example + * await client.calls.callArtifactControllerCallLogsDownload({ + * id: "id" + * }) + */ + public callArtifactControllerCallLogsDownload( + request: Vapi.CallArtifactControllerCallLogsDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__callArtifactControllerCallLogsDownload(request, requestOptions), + ); + } + + private async __callArtifactControllerCallLogsDownload( + request: Vapi.CallArtifactControllerCallLogsDownloadRequest, + requestOptions?: CallsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `call/${core.url.encodePathParam(id)}/call-logs`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 401: + throw new Vapi.UnauthorizedError(_response.error.body as unknown, _response.rawResponse); + case 404: + throw new Vapi.NotFoundError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/call/{id}/call-logs"); + } } diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerAssistantRecordingDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerAssistantRecordingDownloadRequest.ts new file mode 100644 index 00000000..84ac164e --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerAssistantRecordingDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerAssistantRecordingDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerCallLogsDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerCallLogsDownloadRequest.ts new file mode 100644 index 00000000..02527d6a --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerCallLogsDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerCallLogsDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerCustomerRecordingDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerCustomerRecordingDownloadRequest.ts new file mode 100644 index 00000000..26e03bf6 --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerCustomerRecordingDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerCustomerRecordingDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerMonoRecordingDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerMonoRecordingDownloadRequest.ts new file mode 100644 index 00000000..a294d3ea --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerMonoRecordingDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerMonoRecordingDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerPcapDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerPcapDownloadRequest.ts new file mode 100644 index 00000000..952937b9 --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerPcapDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerPcapDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerStereoRecordingDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerStereoRecordingDownloadRequest.ts new file mode 100644 index 00000000..e4544c25 --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerStereoRecordingDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerStereoRecordingDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CallArtifactControllerVideoRecordingDownloadRequest.ts b/src/api/resources/calls/client/requests/CallArtifactControllerVideoRecordingDownloadRequest.ts new file mode 100644 index 00000000..7063605e --- /dev/null +++ b/src/api/resources/calls/client/requests/CallArtifactControllerVideoRecordingDownloadRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CallArtifactControllerVideoRecordingDownloadRequest { + /** Call ID */ + id: string; +} diff --git a/src/api/resources/calls/client/requests/CreateCallDto.ts b/src/api/resources/calls/client/requests/CreateCallDto.ts index 46439628..1c79fa87 100644 --- a/src/api/resources/calls/client/requests/CreateCallDto.ts +++ b/src/api/resources/calls/client/requests/CreateCallDto.ts @@ -7,6 +7,13 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface CreateCallDto { + /** + * This is the assistant version to use for this call. Supported only with + * direct `assistantId`. Omit to follow the latest version. + */ + assistantVersion?: string | null; + /** This is the transport of the call. */ + transport?: Vapi.CreateCallDtoTransport; /** * This is used to issue batch calls to multiple customers. * @@ -17,8 +24,6 @@ export interface CreateCallDto { name?: string; /** This is the schedule plan of the call. */ schedulePlan?: Vapi.SchedulePlan; - /** This is the transport of the call. */ - transport?: Record; /** * This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. * diff --git a/src/api/resources/calls/client/requests/GetCallsRequest.ts b/src/api/resources/calls/client/requests/GetCallsRequest.ts index 50edfeaa..0c4d1b1a 100644 --- a/src/api/resources/calls/client/requests/GetCallsRequest.ts +++ b/src/api/resources/calls/client/requests/GetCallsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetCallsRequest { + /** The unique identifier of the call. */ id: string; } diff --git a/src/api/resources/calls/client/requests/UpdateCallDto.ts b/src/api/resources/calls/client/requests/UpdateCallDto.ts index 781fdeb6..1f68081a 100644 --- a/src/api/resources/calls/client/requests/UpdateCallDto.ts +++ b/src/api/resources/calls/client/requests/UpdateCallDto.ts @@ -7,6 +7,7 @@ * } */ export interface UpdateCallDto { + /** The unique identifier of the call. */ id: string; /** This is the name of the call. This is just for your own reference. */ name?: string; diff --git a/src/api/resources/calls/client/requests/index.ts b/src/api/resources/calls/client/requests/index.ts index 50576a97..e43a62e4 100644 --- a/src/api/resources/calls/client/requests/index.ts +++ b/src/api/resources/calls/client/requests/index.ts @@ -1,3 +1,10 @@ +export type { CallArtifactControllerAssistantRecordingDownloadRequest } from "./CallArtifactControllerAssistantRecordingDownloadRequest.js"; +export type { CallArtifactControllerCallLogsDownloadRequest } from "./CallArtifactControllerCallLogsDownloadRequest.js"; +export type { CallArtifactControllerCustomerRecordingDownloadRequest } from "./CallArtifactControllerCustomerRecordingDownloadRequest.js"; +export type { CallArtifactControllerMonoRecordingDownloadRequest } from "./CallArtifactControllerMonoRecordingDownloadRequest.js"; +export type { CallArtifactControllerPcapDownloadRequest } from "./CallArtifactControllerPcapDownloadRequest.js"; +export type { CallArtifactControllerStereoRecordingDownloadRequest } from "./CallArtifactControllerStereoRecordingDownloadRequest.js"; +export type { CallArtifactControllerVideoRecordingDownloadRequest } from "./CallArtifactControllerVideoRecordingDownloadRequest.js"; export type { CreateCallDto } from "./CreateCallDto.js"; export type { DeleteCallDto } from "./DeleteCallDto.js"; export type { GetCallsRequest } from "./GetCallsRequest.js"; diff --git a/src/api/resources/calls/types/CreateCallDtoTransport.ts b/src/api/resources/calls/types/CreateCallDtoTransport.ts new file mode 100644 index 00000000..5aff6e9c --- /dev/null +++ b/src/api/resources/calls/types/CreateCallDtoTransport.ts @@ -0,0 +1,40 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +/** + * This is the transport of the call. + */ +export type CreateCallDtoTransport = + | Vapi.CreateCallDtoTransport.VapiWebsocket + | Vapi.CreateCallDtoTransport.Vonage + | Vapi.CreateCallDtoTransport.Twilio + | Vapi.CreateCallDtoTransport.VapiSip + | Vapi.CreateCallDtoTransport.Telnyx + | Vapi.CreateCallDtoTransport.Daily; + +export namespace CreateCallDtoTransport { + export interface VapiWebsocket extends Vapi.VapiWebsocketTransport { + provider: "vapi.websocket"; + } + + export interface Vonage extends Vapi.VonageTransport { + provider: "vonage"; + } + + export interface Twilio extends Vapi.TwilioTransport { + provider: "twilio"; + } + + export interface VapiSip extends Vapi.VapiSipTransport { + provider: "vapi.sip"; + } + + export interface Telnyx extends Vapi.TelnyxTransport { + provider: "telnyx"; + } + + export interface Daily extends Vapi.VapiWebCallTransport { + provider: "daily"; + } +} diff --git a/src/api/resources/calls/types/index.ts b/src/api/resources/calls/types/index.ts index 793a3d75..ace0d2a9 100644 --- a/src/api/resources/calls/types/index.ts +++ b/src/api/resources/calls/types/index.ts @@ -1 +1,2 @@ +export * from "./CreateCallDtoTransport.js"; export * from "./CreateCallsResponse.js"; diff --git a/src/api/resources/campaigns/client/Client.ts b/src/api/resources/campaigns/client/Client.ts index a1306e38..45d04fc8 100644 --- a/src/api/resources/campaigns/client/Client.ts +++ b/src/api/resources/campaigns/client/Client.ts @@ -23,6 +23,8 @@ export class CampaignsClient { } /** + * Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. + * * @param {Vapi.CampaignControllerFindAllRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -45,6 +47,7 @@ export class CampaignsClient { status, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -60,6 +63,7 @@ export class CampaignsClient { status: status != null ? status : undefined, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -108,6 +112,8 @@ export class CampaignsClient { } /** + * Creates an outbound calling campaign that calls a set of customers. + * * @param {Vapi.CreateCampaignDto} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -168,6 +174,341 @@ export class CampaignsClient { } /** + * @param {Vapi.CampaignControllerFindAllV2Request} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerFindAllV2() + */ + public campaignControllerFindAllV2( + request: Vapi.CampaignControllerFindAllV2Request = {}, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__campaignControllerFindAllV2(request, requestOptions)); + } + + private async __campaignControllerFindAllV2( + request: Vapi.CampaignControllerFindAllV2Request = {}, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const { + id, + status, + includeCounters, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + id, + status: status != null ? status : undefined, + includeCounters, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "v2/campaign", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { + data: _response.body as Vapi.CampaignSummaryPaginatedResponse, + rawResponse: _response.rawResponse, + }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/campaign"); + } + + /** + * @param {Vapi.CreateCampaignDto} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerCreateV2({ + * name: "Q2 Sales Campaign" + * }) + */ + public campaignControllerCreateV2( + request: Vapi.CreateCampaignDto, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__campaignControllerCreateV2(request, requestOptions)); + } + + private async __campaignControllerCreateV2( + request: Vapi.CreateCampaignDto, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "v2/campaign", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Campaign, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/campaign"); + } + + /** + * @param {Vapi.CampaignControllerFindOneV2Request} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerFindOneV2({ + * id: "id" + * }) + */ + public campaignControllerFindOneV2( + request: Vapi.CampaignControllerFindOneV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__campaignControllerFindOneV2(request, requestOptions)); + } + + private async __campaignControllerFindOneV2( + request: Vapi.CampaignControllerFindOneV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const { id, includeCounters } = request; + const _queryParams: Record = { + includeCounters, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/campaign/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.CampaignSummary, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/campaign/{id}"); + } + + /** + * @param {Vapi.CampaignControllerRemoveV2Request} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerRemoveV2({ + * id: "id" + * }) + */ + public campaignControllerRemoveV2( + request: Vapi.CampaignControllerRemoveV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__campaignControllerRemoveV2(request, requestOptions)); + } + + private async __campaignControllerRemoveV2( + request: Vapi.CampaignControllerRemoveV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/campaign/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Campaign, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v2/campaign/{id}"); + } + + /** + * @param {Vapi.CampaignControllerUpdateV2Request} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerUpdateV2({ + * id: "id", + * body: {} + * }) + */ + public campaignControllerUpdateV2( + request: Vapi.CampaignControllerUpdateV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__campaignControllerUpdateV2(request, requestOptions)); + } + + private async __campaignControllerUpdateV2( + request: Vapi.CampaignControllerUpdateV2Request, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const { id, body: _body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/campaign/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Campaign, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v2/campaign/{id}"); + } + + /** + * Returns the outbound calling campaign identified by its ID. + * * @param {Vapi.CampaignControllerFindOneRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -226,6 +567,8 @@ export class CampaignsClient { } /** + * Deletes the outbound calling campaign identified by its ID. + * * @param {Vapi.CampaignControllerRemoveRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -284,26 +627,29 @@ export class CampaignsClient { } /** - * @param {Vapi.UpdateCampaignDto} request + * Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. + * + * @param {Vapi.CampaignControllerUpdateRequest} request * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.campaigns.campaignControllerUpdate({ - * id: "id" + * id: "id", + * body: {} * }) */ public campaignControllerUpdate( - request: Vapi.UpdateCampaignDto, + request: Vapi.CampaignControllerUpdateRequest, requestOptions?: CampaignsClient.RequestOptions, ): core.HttpResponsePromise { return core.HttpResponsePromise.fromPromise(this.__campaignControllerUpdate(request, requestOptions)); } private async __campaignControllerUpdate( - request: Vapi.UpdateCampaignDto, + request: Vapi.CampaignControllerUpdateRequest, requestOptions?: CampaignsClient.RequestOptions, ): Promise> { - const { id, ..._body } = request; + const { id, body: _body } = request; const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, @@ -343,4 +689,73 @@ export class CampaignsClient { return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/campaign/{id}"); } + + /** + * @param {Vapi.CampaignControllerGetCampaignV2ContactsRequest} request + * @param {CampaignsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.campaigns.campaignControllerGetCampaignV2Contacts({ + * id: "id" + * }) + */ + public campaignControllerGetCampaignV2Contacts( + request: Vapi.CampaignControllerGetCampaignV2ContactsRequest, + requestOptions?: CampaignsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__campaignControllerGetCampaignV2Contacts(request, requestOptions), + ); + } + + private async __campaignControllerGetCampaignV2Contacts( + request: Vapi.CampaignControllerGetCampaignV2ContactsRequest, + requestOptions?: CampaignsClient.RequestOptions, + ): Promise> { + const { id, status, limit, sortBy, page } = request; + const _queryParams: Record = { + status: Array.isArray(status) ? status.map((item) => item) : status != null ? status : undefined, + limit, + sortBy: sortBy != null ? sortBy : undefined, + page, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/campaign/${core.url.encodePathParam(id)}/contacts`, + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { + data: _response.body as Vapi.CampaignContactPaginatedResponse, + rawResponse: _response.rawResponse, + }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/campaign/{id}/contacts"); + } } diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerFindAllRequest.ts b/src/api/resources/campaigns/client/requests/CampaignControllerFindAllRequest.ts index 6e3b2acc..a9065801 100644 --- a/src/api/resources/campaigns/client/requests/CampaignControllerFindAllRequest.ts +++ b/src/api/resources/campaigns/client/requests/CampaignControllerFindAllRequest.ts @@ -7,12 +7,16 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface CampaignControllerFindAllRequest { + /** Filters campaigns by ID. */ id?: string; + /** Filters campaigns by status. */ status?: Vapi.CampaignControllerFindAllRequestStatus; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.CampaignControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.CampaignControllerFindAllRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerFindAllV2Request.ts b/src/api/resources/campaigns/client/requests/CampaignControllerFindAllV2Request.ts new file mode 100644 index 00000000..ed36311d --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerFindAllV2Request.ts @@ -0,0 +1,44 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface CampaignControllerFindAllV2Request { + id?: string; + status?: Vapi.CampaignControllerFindAllV2RequestStatus; + /** + * When true, every campaign in the response includes `contactCounters` and + * `callMetrics`. These are aggregate queries over contacts and events — + * batched across the page, so the cost is three queries per request rather + * than three per campaign, but still opt-in rather than paid for on every + * read. Defaults to false. + */ + includeCounters?: boolean; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.CampaignControllerFindAllV2RequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.CampaignControllerFindAllV2RequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerFindOneRequest.ts b/src/api/resources/campaigns/client/requests/CampaignControllerFindOneRequest.ts index 61d39f4c..79e0c607 100644 --- a/src/api/resources/campaigns/client/requests/CampaignControllerFindOneRequest.ts +++ b/src/api/resources/campaigns/client/requests/CampaignControllerFindOneRequest.ts @@ -7,5 +7,6 @@ * } */ export interface CampaignControllerFindOneRequest { + /** The unique identifier of the campaign. */ id: string; } diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerFindOneV2Request.ts b/src/api/resources/campaigns/client/requests/CampaignControllerFindOneV2Request.ts new file mode 100644 index 00000000..6dbd4704 --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerFindOneV2Request.ts @@ -0,0 +1,18 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CampaignControllerFindOneV2Request { + /** The unique identifier for the resource. */ + id: string; + /** + * When true, the response includes `contactCounters` and `callMetrics`. + * These are aggregate queries over the campaign's contacts and events, so + * they are opt-in rather than paid for on every read. Defaults to false. + */ + includeCounters?: boolean; +} diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerGetCampaignV2ContactsRequest.ts b/src/api/resources/campaigns/client/requests/CampaignControllerGetCampaignV2ContactsRequest.ts new file mode 100644 index 00000000..fab8f494 --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerGetCampaignV2ContactsRequest.ts @@ -0,0 +1,38 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id" + * } + */ +export interface CampaignControllerGetCampaignV2ContactsRequest { + /** The unique identifier for the resource. */ + id: string; + /** + * This is the status to filter contacts by. Pass once or multiple times to + * filter on any of the provided statuses. + */ + status?: + | Vapi.CampaignControllerGetCampaignV2ContactsRequestStatusItem + | Vapi.CampaignControllerGetCampaignV2ContactsRequestStatusItem[]; + /** This is the maximum number of contacts to return. Defaults to 50. */ + limit?: number; + /** + * This is the column to sort by. Defaults to `position` — the order contacts + * were uploaded, which is also dial order. + * + * `status` sorts by the enum's declaration order rather than alphabetically, + * which means it reads as a lifecycle: pending, dispatched, completed, + * failed, skipped, predial-failed. + * + * Only columns on `campaign_contact` are sortable. Call-level values such as + * cost or duration live on the call and are attached after this query, so + * sorting by them here would only reorder the current page. + */ + sortBy?: Vapi.CampaignControllerGetCampaignV2ContactsRequestSortBy; + /** This is the page number to return. Defaults to 1. */ + page?: number; +} diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerRemoveRequest.ts b/src/api/resources/campaigns/client/requests/CampaignControllerRemoveRequest.ts index 501468ec..9a326ad4 100644 --- a/src/api/resources/campaigns/client/requests/CampaignControllerRemoveRequest.ts +++ b/src/api/resources/campaigns/client/requests/CampaignControllerRemoveRequest.ts @@ -7,5 +7,6 @@ * } */ export interface CampaignControllerRemoveRequest { + /** The unique identifier of the campaign. */ id: string; } diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerRemoveV2Request.ts b/src/api/resources/campaigns/client/requests/CampaignControllerRemoveV2Request.ts new file mode 100644 index 00000000..11b61b4e --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerRemoveV2Request.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface CampaignControllerRemoveV2Request { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerUpdateRequest.ts b/src/api/resources/campaigns/client/requests/CampaignControllerUpdateRequest.ts new file mode 100644 index 00000000..c61b939c --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerUpdateRequest.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id", + * body: {} + * } + */ +export interface CampaignControllerUpdateRequest { + /** The unique identifier of the campaign. */ + id: string; + body: Vapi.UpdateCampaignDto; +} diff --git a/src/api/resources/campaigns/client/requests/CampaignControllerUpdateV2Request.ts b/src/api/resources/campaigns/client/requests/CampaignControllerUpdateV2Request.ts new file mode 100644 index 00000000..130f8b34 --- /dev/null +++ b/src/api/resources/campaigns/client/requests/CampaignControllerUpdateV2Request.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id", + * body: {} + * } + */ +export interface CampaignControllerUpdateV2Request { + /** The unique identifier for the resource. */ + id: string; + body: Vapi.UpdateCampaignDto; +} diff --git a/src/api/resources/campaigns/client/requests/CreateCampaignDto.ts b/src/api/resources/campaigns/client/requests/CreateCampaignDto.ts deleted file mode 100644 index ebfd1b6f..00000000 --- a/src/api/resources/campaigns/client/requests/CreateCampaignDto.ts +++ /dev/null @@ -1,28 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -import type * as Vapi from "../../../../index.js"; - -/** - * @example - * { - * name: "Q2 Sales Campaign" - * } - */ -export interface CreateCampaignDto { - /** This is the name of the campaign. This is just for your own reference. */ - name: string; - /** This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ - assistantId?: string; - /** This is the workflow ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ - workflowId?: string; - /** This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ - squadId?: string; - /** This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive. */ - phoneNumberId?: string; - /** This is a list of dial entries, each specifying a phone number and the customers to call using that number. Use this when you want different phone numbers to call different sets of customers. Note: phoneNumberId and dialPlan are mutually exclusive. */ - dialPlan?: Vapi.DialPlanEntry[]; - /** This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried. */ - schedulePlan?: Vapi.SchedulePlan; - /** These are the customers that will be called in the campaign. Required if dialPlan is not provided. */ - customers?: Vapi.CreateCustomerDto[]; -} diff --git a/src/api/resources/campaigns/client/requests/index.ts b/src/api/resources/campaigns/client/requests/index.ts index 4a810eeb..96244761 100644 --- a/src/api/resources/campaigns/client/requests/index.ts +++ b/src/api/resources/campaigns/client/requests/index.ts @@ -1,5 +1,9 @@ export type { CampaignControllerFindAllRequest } from "./CampaignControllerFindAllRequest.js"; +export type { CampaignControllerFindAllV2Request } from "./CampaignControllerFindAllV2Request.js"; export type { CampaignControllerFindOneRequest } from "./CampaignControllerFindOneRequest.js"; +export type { CampaignControllerFindOneV2Request } from "./CampaignControllerFindOneV2Request.js"; +export type { CampaignControllerGetCampaignV2ContactsRequest } from "./CampaignControllerGetCampaignV2ContactsRequest.js"; export type { CampaignControllerRemoveRequest } from "./CampaignControllerRemoveRequest.js"; -export type { CreateCampaignDto } from "./CreateCampaignDto.js"; -export type { UpdateCampaignDto } from "./UpdateCampaignDto.js"; +export type { CampaignControllerRemoveV2Request } from "./CampaignControllerRemoveV2Request.js"; +export type { CampaignControllerUpdateRequest } from "./CampaignControllerUpdateRequest.js"; +export type { CampaignControllerUpdateV2Request } from "./CampaignControllerUpdateV2Request.js"; diff --git a/src/api/resources/campaigns/types/CampaignControllerFindAllRequestSortBy.ts b/src/api/resources/campaigns/types/CampaignControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..5e7ac191 --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type CampaignControllerFindAllRequestSortBy = + (typeof CampaignControllerFindAllRequestSortBy)[keyof typeof CampaignControllerFindAllRequestSortBy]; diff --git a/src/api/resources/campaigns/types/CampaignControllerFindAllRequestStatus.ts b/src/api/resources/campaigns/types/CampaignControllerFindAllRequestStatus.ts index e063be84..40b4efac 100644 --- a/src/api/resources/campaigns/types/CampaignControllerFindAllRequestStatus.ts +++ b/src/api/resources/campaigns/types/CampaignControllerFindAllRequestStatus.ts @@ -4,6 +4,8 @@ export const CampaignControllerFindAllRequestStatus = { Scheduled: "scheduled", InProgress: "in-progress", Ended: "ended", + Cancelled: "cancelled", + Archived: "archived", } as const; export type CampaignControllerFindAllRequestStatus = (typeof CampaignControllerFindAllRequestStatus)[keyof typeof CampaignControllerFindAllRequestStatus]; diff --git a/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortBy.ts b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortBy.ts new file mode 100644 index 00000000..4d8cffbd --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerFindAllV2RequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type CampaignControllerFindAllV2RequestSortBy = + (typeof CampaignControllerFindAllV2RequestSortBy)[keyof typeof CampaignControllerFindAllV2RequestSortBy]; diff --git a/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortOrder.ts b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortOrder.ts new file mode 100644 index 00000000..a66cc25c --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerFindAllV2RequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type CampaignControllerFindAllV2RequestSortOrder = + (typeof CampaignControllerFindAllV2RequestSortOrder)[keyof typeof CampaignControllerFindAllV2RequestSortOrder]; diff --git a/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestStatus.ts b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestStatus.ts new file mode 100644 index 00000000..e76a17a3 --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerFindAllV2RequestStatus.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerFindAllV2RequestStatus = { + Scheduled: "scheduled", + InProgress: "in-progress", + Ended: "ended", + Cancelled: "cancelled", + Archived: "archived", +} as const; +export type CampaignControllerFindAllV2RequestStatus = + (typeof CampaignControllerFindAllV2RequestStatus)[keyof typeof CampaignControllerFindAllV2RequestStatus]; diff --git a/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestSortBy.ts b/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestSortBy.ts new file mode 100644 index 00000000..7b88e42e --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestSortBy.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerGetCampaignV2ContactsRequestSortBy = { + Position: "position", + Status: "status", +} as const; +export type CampaignControllerGetCampaignV2ContactsRequestSortBy = + (typeof CampaignControllerGetCampaignV2ContactsRequestSortBy)[keyof typeof CampaignControllerGetCampaignV2ContactsRequestSortBy]; diff --git a/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestStatusItem.ts b/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestStatusItem.ts new file mode 100644 index 00000000..2924a875 --- /dev/null +++ b/src/api/resources/campaigns/types/CampaignControllerGetCampaignV2ContactsRequestStatusItem.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignControllerGetCampaignV2ContactsRequestStatusItem = { + ContactPending: "contact.pending", + ContactDispatched: "contact.dispatched", + ContactCompleted: "contact.completed", + ContactFailed: "contact.failed", + ContactSkipped: "contact.skipped", + ContactPredialFailed: "contact.predial-failed", +} as const; +export type CampaignControllerGetCampaignV2ContactsRequestStatusItem = + (typeof CampaignControllerGetCampaignV2ContactsRequestStatusItem)[keyof typeof CampaignControllerGetCampaignV2ContactsRequestStatusItem]; diff --git a/src/api/resources/campaigns/types/index.ts b/src/api/resources/campaigns/types/index.ts index c6eb5e02..6835b080 100644 --- a/src/api/resources/campaigns/types/index.ts +++ b/src/api/resources/campaigns/types/index.ts @@ -1,3 +1,8 @@ +export * from "./CampaignControllerFindAllRequestSortBy.js"; export * from "./CampaignControllerFindAllRequestSortOrder.js"; export * from "./CampaignControllerFindAllRequestStatus.js"; -export * from "./UpdateCampaignDtoStatus.js"; +export * from "./CampaignControllerFindAllV2RequestSortBy.js"; +export * from "./CampaignControllerFindAllV2RequestSortOrder.js"; +export * from "./CampaignControllerFindAllV2RequestStatus.js"; +export * from "./CampaignControllerGetCampaignV2ContactsRequestSortBy.js"; +export * from "./CampaignControllerGetCampaignV2ContactsRequestStatusItem.js"; diff --git a/src/api/resources/chats/client/Client.ts b/src/api/resources/chats/client/Client.ts index 647e187a..b156eddf 100644 --- a/src/api/resources/chats/client/Client.ts +++ b/src/api/resources/chats/client/Client.ts @@ -51,8 +51,10 @@ export class ChatsClient { squadId, sessionId, previousChatId, + idAny, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -70,8 +72,10 @@ export class ChatsClient { squadId, sessionId, previousChatId, + idAny, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, diff --git a/src/api/resources/chats/client/requests/ListChatsRequest.ts b/src/api/resources/chats/client/requests/ListChatsRequest.ts index c896c65b..e1a98bbf 100644 --- a/src/api/resources/chats/client/requests/ListChatsRequest.ts +++ b/src/api/resources/chats/client/requests/ListChatsRequest.ts @@ -21,10 +21,14 @@ export interface ListChatsRequest { sessionId?: string; /** This is the unique identifier for the previous chat to filter by. */ previousChatId?: string; + /** Filter by multiple chat IDs. Provide as comma-separated values. */ + idAny?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ListChatsRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ListChatsRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/chats/types/ListChatsRequestSortBy.ts b/src/api/resources/chats/types/ListChatsRequestSortBy.ts new file mode 100644 index 00000000..e6ae89c6 --- /dev/null +++ b/src/api/resources/chats/types/ListChatsRequestSortBy.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ListChatsRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ListChatsRequestSortBy = (typeof ListChatsRequestSortBy)[keyof typeof ListChatsRequestSortBy]; diff --git a/src/api/resources/chats/types/index.ts b/src/api/resources/chats/types/index.ts index 543ead75..14ec0de1 100644 --- a/src/api/resources/chats/types/index.ts +++ b/src/api/resources/chats/types/index.ts @@ -2,6 +2,7 @@ export * from "./CreateChatDtoInput.js"; export * from "./CreateChatDtoInputOneItem.js"; export * from "./CreateChatsResponse.js"; export * from "./CreateResponseChatsResponse.js"; +export * from "./ListChatsRequestSortBy.js"; export * from "./ListChatsRequestSortOrder.js"; export * from "./OpenAiResponsesRequestInput.js"; export * from "./OpenAiResponsesRequestInputOneItem.js"; diff --git a/src/api/resources/eval/client/Client.ts b/src/api/resources/eval/client/Client.ts index b522c9f2..7fdf1dd1 100644 --- a/src/api/resources/eval/client/Client.ts +++ b/src/api/resources/eval/client/Client.ts @@ -23,6 +23,8 @@ export class EvalClient { } /** + * Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.EvalControllerGetPaginatedRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -44,6 +46,7 @@ export class EvalClient { id, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -58,6 +61,7 @@ export class EvalClient { id, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -106,6 +110,8 @@ export class EvalClient { } /** + * Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. + * * @param {Vapi.CreateEvalDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -169,6 +175,8 @@ export class EvalClient { } /** + * Returns the eval definition identified by its ID. + * * @param {Vapi.EvalControllerGetRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -227,6 +235,8 @@ export class EvalClient { } /** + * Deletes the eval definition identified by its ID. + * * @param {Vapi.EvalControllerRemoveRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -285,6 +295,8 @@ export class EvalClient { } /** + * Updates the eval definition identified by its ID. + * * @param {Vapi.UpdateEvalDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -346,6 +358,8 @@ export class EvalClient { } /** + * Returns the eval run identified by its ID. + * * @param {Vapi.EvalControllerGetRunRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -404,6 +418,8 @@ export class EvalClient { } /** + * Deletes the eval run identified by its ID. + * * @param {Vapi.EvalControllerRemoveRunRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -462,6 +478,8 @@ export class EvalClient { } /** + * Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.EvalControllerGetRunsPaginatedRequest} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -483,6 +501,7 @@ export class EvalClient { id, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -497,6 +516,7 @@ export class EvalClient { id, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -545,6 +565,8 @@ export class EvalClient { } /** + * Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. + * * @param {Vapi.CreateEvalRunDto} request * @param {EvalClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/eval/client/requests/EvalControllerGetPaginatedRequest.ts b/src/api/resources/eval/client/requests/EvalControllerGetPaginatedRequest.ts index ec615a27..75ec1503 100644 --- a/src/api/resources/eval/client/requests/EvalControllerGetPaginatedRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerGetPaginatedRequest.ts @@ -7,11 +7,14 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface EvalControllerGetPaginatedRequest { + /** Filters eval definitions by ID. */ id?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.EvalControllerGetPaginatedRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.EvalControllerGetPaginatedRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/eval/client/requests/EvalControllerGetRequest.ts b/src/api/resources/eval/client/requests/EvalControllerGetRequest.ts index c0d4d7d3..f55a5106 100644 --- a/src/api/resources/eval/client/requests/EvalControllerGetRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerGetRequest.ts @@ -7,5 +7,6 @@ * } */ export interface EvalControllerGetRequest { + /** The unique identifier of the eval definition. */ id: string; } diff --git a/src/api/resources/eval/client/requests/EvalControllerGetRunRequest.ts b/src/api/resources/eval/client/requests/EvalControllerGetRunRequest.ts index 09b11482..d2f91a95 100644 --- a/src/api/resources/eval/client/requests/EvalControllerGetRunRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerGetRunRequest.ts @@ -7,5 +7,6 @@ * } */ export interface EvalControllerGetRunRequest { + /** The unique identifier of the eval run. */ id: string; } diff --git a/src/api/resources/eval/client/requests/EvalControllerGetRunsPaginatedRequest.ts b/src/api/resources/eval/client/requests/EvalControllerGetRunsPaginatedRequest.ts index 7fb65c0d..a9957a74 100644 --- a/src/api/resources/eval/client/requests/EvalControllerGetRunsPaginatedRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerGetRunsPaginatedRequest.ts @@ -7,11 +7,14 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface EvalControllerGetRunsPaginatedRequest { + /** Filters eval runs by ID. */ id?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.EvalControllerGetRunsPaginatedRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.EvalControllerGetRunsPaginatedRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/eval/client/requests/EvalControllerRemoveRequest.ts b/src/api/resources/eval/client/requests/EvalControllerRemoveRequest.ts index 308e0f33..7f5328aa 100644 --- a/src/api/resources/eval/client/requests/EvalControllerRemoveRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerRemoveRequest.ts @@ -7,5 +7,6 @@ * } */ export interface EvalControllerRemoveRequest { + /** The unique identifier of the eval definition. */ id: string; } diff --git a/src/api/resources/eval/client/requests/EvalControllerRemoveRunRequest.ts b/src/api/resources/eval/client/requests/EvalControllerRemoveRunRequest.ts index 3d4be523..76eab781 100644 --- a/src/api/resources/eval/client/requests/EvalControllerRemoveRunRequest.ts +++ b/src/api/resources/eval/client/requests/EvalControllerRemoveRunRequest.ts @@ -7,5 +7,6 @@ * } */ export interface EvalControllerRemoveRunRequest { + /** The unique identifier of the eval run. */ id: string; } diff --git a/src/api/resources/eval/client/requests/UpdateEvalDto.ts b/src/api/resources/eval/client/requests/UpdateEvalDto.ts index 95fe1986..6081d351 100644 --- a/src/api/resources/eval/client/requests/UpdateEvalDto.ts +++ b/src/api/resources/eval/client/requests/UpdateEvalDto.ts @@ -9,6 +9,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateEvalDto { + /** The unique identifier of the eval definition. */ id: string; /** * This is the mock conversation that will be used to evaluate the flow of the conversation. diff --git a/src/api/resources/eval/types/CreateEvalRunDtoTarget.ts b/src/api/resources/eval/types/CreateEvalRunDtoTarget.ts index 88f33f1a..34d3ff63 100644 --- a/src/api/resources/eval/types/CreateEvalRunDtoTarget.ts +++ b/src/api/resources/eval/types/CreateEvalRunDtoTarget.ts @@ -15,4 +15,9 @@ export namespace CreateEvalRunDtoTarget { export interface Squad extends Vapi.EvalRunTargetSquad { type: "squad"; } + + /** + * This is the target that will be run against the eval + */ + export type Response = Vapi.CreateEvalRunDtoTarget.Assistant | Vapi.CreateEvalRunDtoTarget.Squad; } diff --git a/src/api/resources/eval/types/EvalControllerGetPaginatedRequestSortBy.ts b/src/api/resources/eval/types/EvalControllerGetPaginatedRequestSortBy.ts new file mode 100644 index 00000000..03c8a25f --- /dev/null +++ b/src/api/resources/eval/types/EvalControllerGetPaginatedRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const EvalControllerGetPaginatedRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type EvalControllerGetPaginatedRequestSortBy = + (typeof EvalControllerGetPaginatedRequestSortBy)[keyof typeof EvalControllerGetPaginatedRequestSortBy]; diff --git a/src/api/resources/eval/types/EvalControllerGetRunsPaginatedRequestSortBy.ts b/src/api/resources/eval/types/EvalControllerGetRunsPaginatedRequestSortBy.ts new file mode 100644 index 00000000..d9ca453f --- /dev/null +++ b/src/api/resources/eval/types/EvalControllerGetRunsPaginatedRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const EvalControllerGetRunsPaginatedRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type EvalControllerGetRunsPaginatedRequestSortBy = + (typeof EvalControllerGetRunsPaginatedRequestSortBy)[keyof typeof EvalControllerGetRunsPaginatedRequestSortBy]; diff --git a/src/api/resources/eval/types/index.ts b/src/api/resources/eval/types/index.ts index 39f41742..2874ca67 100644 --- a/src/api/resources/eval/types/index.ts +++ b/src/api/resources/eval/types/index.ts @@ -1,6 +1,8 @@ export * from "./CreateEvalRunDtoTarget.js"; export * from "./CreateEvalRunDtoType.js"; +export * from "./EvalControllerGetPaginatedRequestSortBy.js"; export * from "./EvalControllerGetPaginatedRequestSortOrder.js"; +export * from "./EvalControllerGetRunsPaginatedRequestSortBy.js"; export * from "./EvalControllerGetRunsPaginatedRequestSortOrder.js"; export * from "./UpdateEvalDtoMessagesItem.js"; export * from "./UpdateEvalDtoType.js"; diff --git a/src/api/resources/files/client/Client.ts b/src/api/resources/files/client/Client.ts index 2d45974e..2085f038 100644 --- a/src/api/resources/files/client/Client.ts +++ b/src/api/resources/files/client/Client.ts @@ -23,16 +23,31 @@ export class FilesClient { } /** + * Returns files uploaded to the authenticated organization. + * + * @param {Vapi.ListFilesRequest} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * * @example - * await client.files.list() + * await client.files.list({ + * purpose: "purpose" + * }) */ - public list(requestOptions?: FilesClient.RequestOptions): core.HttpResponsePromise { - return core.HttpResponsePromise.fromPromise(this.__list(requestOptions)); + public list( + request: Vapi.ListFilesRequest, + requestOptions?: FilesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions)); } - private async __list(requestOptions?: FilesClient.RequestOptions): Promise> { + private async __list( + request: Vapi.ListFilesRequest, + requestOptions?: FilesClient.RequestOptions, + ): Promise> { + const { purpose } = request; + const _queryParams: Record = { + purpose, + }; const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, @@ -48,7 +63,7 @@ export class FilesClient { ), method: "GET", headers: _headers, - queryParameters: requestOptions?.queryParams, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, abortSignal: requestOptions?.abortSignal, @@ -71,6 +86,8 @@ export class FilesClient { } /** + * Uploads a file for use with a Vapi knowledge base. + * * @param {Vapi.CreateFileDto} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -95,6 +112,14 @@ export class FilesClient { ): Promise> { const _body = await core.newFormData(); await _body.appendFile("file", request.file); + if (request.purpose != null) { + _body.append("purpose", request.purpose); + } + + if (request.metadata != null) { + _body.append("metadata", request.metadata); + } + const _maybeEncodedRequest = await _body.getRequest(); const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( @@ -143,6 +168,8 @@ export class FilesClient { } /** + * Returns the uploaded file identified by its ID. + * * @param {Vapi.GetFilesRequest} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -201,6 +228,8 @@ export class FilesClient { } /** + * Deletes the uploaded file identified by its ID. + * * @param {Vapi.DeleteFilesRequest} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -259,6 +288,8 @@ export class FilesClient { } /** + * Updates the name of the uploaded file identified by its ID. + * * @param {Vapi.UpdateFileDto} request * @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/files/client/requests/CreateFileDto.ts b/src/api/resources/files/client/requests/CreateFileDto.ts index aa777793..072c72fc 100644 --- a/src/api/resources/files/client/requests/CreateFileDto.ts +++ b/src/api/resources/files/client/requests/CreateFileDto.ts @@ -1,6 +1,7 @@ // This file was auto-generated by Fern from our API Definition. import type * as core from "../../../../../core/index.js"; +import type * as Vapi from "../../../../index.js"; /** * @example @@ -9,6 +10,10 @@ import type * as core from "../../../../../core/index.js"; * } */ export interface CreateFileDto { - /** This is the File you want to upload for use with the Knowledge Base. */ + /** The file to upload. */ file: core.file.Uploadable; + /** Optional product flow that owns the uploaded file. */ + purpose?: Vapi.CreateFilesRequestPurpose; + /** Optional JSON-encoded metadata for multipart uploads. */ + metadata?: string; } diff --git a/src/api/resources/files/client/requests/DeleteFilesRequest.ts b/src/api/resources/files/client/requests/DeleteFilesRequest.ts index 31ea64cb..a89743e5 100644 --- a/src/api/resources/files/client/requests/DeleteFilesRequest.ts +++ b/src/api/resources/files/client/requests/DeleteFilesRequest.ts @@ -7,5 +7,6 @@ * } */ export interface DeleteFilesRequest { + /** The unique identifier of the file. */ id: string; } diff --git a/src/api/resources/files/client/requests/GetFilesRequest.ts b/src/api/resources/files/client/requests/GetFilesRequest.ts index b229354a..7b886e34 100644 --- a/src/api/resources/files/client/requests/GetFilesRequest.ts +++ b/src/api/resources/files/client/requests/GetFilesRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetFilesRequest { + /** The unique identifier of the file. */ id: string; } diff --git a/src/api/resources/files/client/requests/ListFilesRequest.ts b/src/api/resources/files/client/requests/ListFilesRequest.ts new file mode 100644 index 00000000..8c767c49 --- /dev/null +++ b/src/api/resources/files/client/requests/ListFilesRequest.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * purpose: "purpose" + * } + */ +export interface ListFilesRequest { + purpose: string; +} diff --git a/src/api/resources/files/client/requests/UpdateFileDto.ts b/src/api/resources/files/client/requests/UpdateFileDto.ts index 5c5cc901..a856c5b7 100644 --- a/src/api/resources/files/client/requests/UpdateFileDto.ts +++ b/src/api/resources/files/client/requests/UpdateFileDto.ts @@ -7,6 +7,7 @@ * } */ export interface UpdateFileDto { + /** The unique identifier of the file. */ id: string; /** This is the name of the file. This is just for your own reference. */ name?: string; diff --git a/src/api/resources/files/client/requests/index.ts b/src/api/resources/files/client/requests/index.ts index 6c4072f7..17c2fcea 100644 --- a/src/api/resources/files/client/requests/index.ts +++ b/src/api/resources/files/client/requests/index.ts @@ -1,4 +1,5 @@ export type { CreateFileDto } from "./CreateFileDto.js"; export type { DeleteFilesRequest } from "./DeleteFilesRequest.js"; export type { GetFilesRequest } from "./GetFilesRequest.js"; +export type { ListFilesRequest } from "./ListFilesRequest.js"; export type { UpdateFileDto } from "./UpdateFileDto.js"; diff --git a/src/api/resources/files/index.ts b/src/api/resources/files/index.ts index 914b8c3c..d9adb1af 100644 --- a/src/api/resources/files/index.ts +++ b/src/api/resources/files/index.ts @@ -1 +1,2 @@ export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/files/types/CreateFilesRequestPurpose.ts b/src/api/resources/files/types/CreateFilesRequestPurpose.ts new file mode 100644 index 00000000..fb126e5b --- /dev/null +++ b/src/api/resources/files/types/CreateFilesRequestPurpose.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Optional product flow that owns the uploaded file. */ +export const CreateFilesRequestPurpose = { + Assistant: "assistant", + ComposerAttachment: "composer-attachment", + KnowledgeBaseV2: "knowledge-base-v2", +} as const; +export type CreateFilesRequestPurpose = (typeof CreateFilesRequestPurpose)[keyof typeof CreateFilesRequestPurpose]; diff --git a/src/api/resources/files/types/index.ts b/src/api/resources/files/types/index.ts new file mode 100644 index 00000000..ed57d2c7 --- /dev/null +++ b/src/api/resources/files/types/index.ts @@ -0,0 +1 @@ +export * from "./CreateFilesRequestPurpose.js"; diff --git a/src/api/resources/index.ts b/src/api/resources/index.ts index b853c152..97bcb8b4 100644 --- a/src/api/resources/index.ts +++ b/src/api/resources/index.ts @@ -3,6 +3,9 @@ export * as analytics from "./analytics/index.js"; export * from "./assistants/client/requests/index.js"; export * as assistants from "./assistants/index.js"; export * from "./assistants/types/index.js"; +export * from "./board/client/requests/index.js"; +export * as board from "./board/index.js"; +export * from "./board/types/index.js"; export * from "./calls/client/requests/index.js"; export * as calls from "./calls/index.js"; export * from "./calls/types/index.js"; @@ -17,9 +20,12 @@ export * as eval from "./eval/index.js"; export * from "./eval/types/index.js"; export * from "./files/client/requests/index.js"; export * as files from "./files/index.js"; +export * from "./files/types/index.js"; export * from "./insight/client/requests/index.js"; export * as insight from "./insight/index.js"; export * from "./insight/types/index.js"; +export * from "./knowledgeBasesV2/client/requests/index.js"; +export * as knowledgeBasesV2 from "./knowledgeBasesV2/index.js"; export * from "./observabilityScorecard/client/requests/index.js"; export * as observabilityScorecard from "./observabilityScorecard/index.js"; export * from "./observabilityScorecard/types/index.js"; @@ -32,6 +38,21 @@ export * from "./providerResources/types/index.js"; export * from "./sessions/client/requests/index.js"; export * as sessions from "./sessions/index.js"; export * from "./sessions/types/index.js"; +export * from "./simulationPersonalities/client/requests/index.js"; +export * as simulationPersonalities from "./simulationPersonalities/index.js"; +export * from "./simulationPersonalities/types/index.js"; +export * from "./simulationRuns/client/requests/index.js"; +export * as simulationRuns from "./simulationRuns/index.js"; +export * from "./simulationRuns/types/index.js"; +export * from "./simulationScenarios/client/requests/index.js"; +export * as simulationScenarios from "./simulationScenarios/index.js"; +export * from "./simulationScenarios/types/index.js"; +export * from "./simulationSuites/client/requests/index.js"; +export * as simulationSuites from "./simulationSuites/index.js"; +export * from "./simulationSuites/types/index.js"; +export * from "./simulations/client/requests/index.js"; +export * as simulations from "./simulations/index.js"; +export * from "./simulations/types/index.js"; export * from "./squads/client/requests/index.js"; export * as squads from "./squads/index.js"; export * from "./structuredOutputs/client/requests/index.js"; diff --git a/src/api/resources/insight/client/Client.ts b/src/api/resources/insight/client/Client.ts index 9238c4c3..de461342 100644 --- a/src/api/resources/insight/client/Client.ts +++ b/src/api/resources/insight/client/Client.ts @@ -23,6 +23,8 @@ export class InsightClient { } /** + * Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.InsightControllerFindAllRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -44,6 +46,7 @@ export class InsightClient { id, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -58,6 +61,7 @@ export class InsightClient { id, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -106,6 +110,8 @@ export class InsightClient { } /** + * Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. + * * @param {Vapi.InsightControllerCreateRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -172,6 +178,8 @@ export class InsightClient { } /** + * Returns the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerFindOneRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -233,6 +241,8 @@ export class InsightClient { } /** + * Deletes the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerRemoveRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -291,6 +301,8 @@ export class InsightClient { } /** + * Updates the reporting insight identified by its ID. + * * @param {Vapi.InsightControllerUpdateRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -355,6 +367,8 @@ export class InsightClient { } /** + * Runs a saved reporting insight, optionally overriding its time range and response format. + * * @param {Vapi.InsightRunDto} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -416,6 +430,8 @@ export class InsightClient { } /** + * Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + * * @param {Vapi.InsightControllerPreviewRequest} request * @param {InsightClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/insight/client/requests/InsightControllerFindAllRequest.ts b/src/api/resources/insight/client/requests/InsightControllerFindAllRequest.ts index 3eb61b48..edec5e70 100644 --- a/src/api/resources/insight/client/requests/InsightControllerFindAllRequest.ts +++ b/src/api/resources/insight/client/requests/InsightControllerFindAllRequest.ts @@ -7,11 +7,14 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface InsightControllerFindAllRequest { + /** Filters reporting insights by ID. */ id?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.InsightControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.InsightControllerFindAllRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/insight/client/requests/InsightControllerFindOneRequest.ts b/src/api/resources/insight/client/requests/InsightControllerFindOneRequest.ts index e4566452..98561295 100644 --- a/src/api/resources/insight/client/requests/InsightControllerFindOneRequest.ts +++ b/src/api/resources/insight/client/requests/InsightControllerFindOneRequest.ts @@ -7,5 +7,6 @@ * } */ export interface InsightControllerFindOneRequest { + /** The unique identifier of the reporting insight. */ id: string; } diff --git a/src/api/resources/insight/client/requests/InsightControllerRemoveRequest.ts b/src/api/resources/insight/client/requests/InsightControllerRemoveRequest.ts index c12e5706..eb8f1939 100644 --- a/src/api/resources/insight/client/requests/InsightControllerRemoveRequest.ts +++ b/src/api/resources/insight/client/requests/InsightControllerRemoveRequest.ts @@ -7,5 +7,6 @@ * } */ export interface InsightControllerRemoveRequest { + /** The unique identifier of the reporting insight. */ id: string; } diff --git a/src/api/resources/insight/client/requests/InsightControllerUpdateRequest.ts b/src/api/resources/insight/client/requests/InsightControllerUpdateRequest.ts index 82e784b3..23f12a57 100644 --- a/src/api/resources/insight/client/requests/InsightControllerUpdateRequest.ts +++ b/src/api/resources/insight/client/requests/InsightControllerUpdateRequest.ts @@ -12,6 +12,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface InsightControllerUpdateRequest { + /** The unique identifier of the reporting insight. */ id: string; body: Vapi.InsightControllerUpdateRequestBody; } diff --git a/src/api/resources/insight/client/requests/InsightRunDto.ts b/src/api/resources/insight/client/requests/InsightRunDto.ts index 6693ba33..c85e52cd 100644 --- a/src/api/resources/insight/client/requests/InsightRunDto.ts +++ b/src/api/resources/insight/client/requests/InsightRunDto.ts @@ -9,7 +9,9 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface InsightRunDto { + /** The unique identifier of the reporting insight. */ id: string; + /** Output-formatting instructions applied to the insight run. */ formatPlan?: Vapi.InsightRunFormatPlan; /** * This is the optional time range override for the insight. @@ -21,4 +23,9 @@ export interface InsightRunDto { * For Pie and Text Insights, step will be ignored even if provided. */ timeRangeOverride?: Vapi.InsightTimeRangeWithStep; + /** + * Optional runtime assistant scope for dashboards. + * This is applied to call-table queries without mutating the saved insight. + */ + assistantId?: string; } diff --git a/src/api/resources/insight/types/InsightControllerFindAllRequestSortBy.ts b/src/api/resources/insight/types/InsightControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..61384e3d --- /dev/null +++ b/src/api/resources/insight/types/InsightControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const InsightControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type InsightControllerFindAllRequestSortBy = + (typeof InsightControllerFindAllRequestSortBy)[keyof typeof InsightControllerFindAllRequestSortBy]; diff --git a/src/api/resources/insight/types/index.ts b/src/api/resources/insight/types/index.ts index 384a5641..562d5c80 100644 --- a/src/api/resources/insight/types/index.ts +++ b/src/api/resources/insight/types/index.ts @@ -1,5 +1,6 @@ export * from "./InsightControllerCreateRequest.js"; export * from "./InsightControllerCreateResponse.js"; +export * from "./InsightControllerFindAllRequestSortBy.js"; export * from "./InsightControllerFindAllRequestSortOrder.js"; export * from "./InsightControllerFindOneResponse.js"; export * from "./InsightControllerPreviewRequest.js"; diff --git a/src/api/resources/knowledgeBasesV2/client/Client.ts b/src/api/resources/knowledgeBasesV2/client/Client.ts new file mode 100644 index 00000000..0ff1cba6 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/Client.ts @@ -0,0 +1,572 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace KnowledgeBasesV2Client { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class KnowledgeBasesV2Client { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: KnowledgeBasesV2Client.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerFindAllRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindAll() + */ + public knowledgeBaseV2ControllerFindAll( + request: Vapi.KnowledgeBaseV2ControllerFindAllRequest = {}, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerFindAll(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerFindAll( + request: Vapi.KnowledgeBaseV2ControllerFindAllRequest = {}, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { limit } = request; + const _queryParams: Record = { + limit, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "v2/knowledge-base", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/knowledge-base"); + } + + /** + * @param {Vapi.CreateKnowledgeBaseV2Dto} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerCreate({ + * name: "name" + * }) + */ + public knowledgeBaseV2ControllerCreate( + request: Vapi.CreateKnowledgeBaseV2Dto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerCreate(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerCreate( + request: Vapi.CreateKnowledgeBaseV2Dto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "v2/knowledge-base", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/knowledge-base"); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerFilesGetRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFilesGet({ + * id: "id" + * }) + */ + public knowledgeBaseV2ControllerFilesGet( + request: Vapi.KnowledgeBaseV2ControllerFilesGetRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerFilesGet(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerFilesGet( + request: Vapi.KnowledgeBaseV2ControllerFilesGetRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}/file`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2File[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/knowledge-base/{id}/file"); + } + + /** + * @param {Vapi.AttachKnowledgeBaseV2FileDto} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileAttach({ + * id: "id", + * fileId: "fileId" + * }) + */ + public knowledgeBaseV2ControllerFileAttach( + request: Vapi.AttachKnowledgeBaseV2FileDto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__knowledgeBaseV2ControllerFileAttach(request, requestOptions), + ); + } + + private async __knowledgeBaseV2ControllerFileAttach( + request: Vapi.AttachKnowledgeBaseV2FileDto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}/file`, + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2File, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v2/knowledge-base/{id}/file"); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerFileDetachRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileDetach({ + * id: "id", + * fileId: "fileId" + * }) + */ + public knowledgeBaseV2ControllerFileDetach( + request: Vapi.KnowledgeBaseV2ControllerFileDetachRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__knowledgeBaseV2ControllerFileDetach(request, requestOptions), + ); + } + + private async __knowledgeBaseV2ControllerFileDetach( + request: Vapi.KnowledgeBaseV2ControllerFileDetachRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id, fileId } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}/file/${core.url.encodePathParam(fileId)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2File, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "DELETE", + "/v2/knowledge-base/{id}/file/{fileId}", + ); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerFileRetryRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileRetry({ + * id: "id", + * fileId: "fileId" + * }) + */ + public knowledgeBaseV2ControllerFileRetry( + request: Vapi.KnowledgeBaseV2ControllerFileRetryRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerFileRetry(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerFileRetry( + request: Vapi.KnowledgeBaseV2ControllerFileRetryRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id, fileId } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}/file/${core.url.encodePathParam(fileId)}/retry`, + ), + method: "POST", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2File, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "POST", + "/v2/knowledge-base/{id}/file/{fileId}/retry", + ); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerFindOneRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindOne({ + * id: "id" + * }) + */ + public knowledgeBaseV2ControllerFindOne( + request: Vapi.KnowledgeBaseV2ControllerFindOneRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerFindOne(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerFindOne( + request: Vapi.KnowledgeBaseV2ControllerFindOneRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2WithFiles, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v2/knowledge-base/{id}"); + } + + /** + * @param {Vapi.KnowledgeBaseV2ControllerRemoveRequest} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerRemove({ + * id: "id" + * }) + */ + public knowledgeBaseV2ControllerRemove( + request: Vapi.KnowledgeBaseV2ControllerRemoveRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerRemove(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerRemove( + request: Vapi.KnowledgeBaseV2ControllerRemoveRequest, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v2/knowledge-base/{id}"); + } + + /** + * @param {Vapi.UpdateKnowledgeBaseV2Dto} request + * @param {KnowledgeBasesV2Client.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.knowledgeBasesV2.knowledgeBaseV2ControllerUpdate({ + * id: "id" + * }) + */ + public knowledgeBaseV2ControllerUpdate( + request: Vapi.UpdateKnowledgeBaseV2Dto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__knowledgeBaseV2ControllerUpdate(request, requestOptions)); + } + + private async __knowledgeBaseV2ControllerUpdate( + request: Vapi.UpdateKnowledgeBaseV2Dto, + requestOptions?: KnowledgeBasesV2Client.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `v2/knowledge-base/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.KnowledgeBaseV2, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v2/knowledge-base/{id}"); + } +} diff --git a/src/api/resources/knowledgeBasesV2/client/index.ts b/src/api/resources/knowledgeBasesV2/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/resources/knowledgeBasesV2/client/requests/AttachKnowledgeBaseV2FileDto.ts b/src/api/resources/knowledgeBasesV2/client/requests/AttachKnowledgeBaseV2FileDto.ts new file mode 100644 index 00000000..f6454e00 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/AttachKnowledgeBaseV2FileDto.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * fileId: "fileId" + * } + */ +export interface AttachKnowledgeBaseV2FileDto { + /** The unique identifier for the resource. */ + id: string; + fileId: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/CreateKnowledgeBaseV2Dto.ts b/src/api/resources/knowledgeBasesV2/client/requests/CreateKnowledgeBaseV2Dto.ts new file mode 100644 index 00000000..547d0fa4 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/CreateKnowledgeBaseV2Dto.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * name: "name" + * } + */ +export interface CreateKnowledgeBaseV2Dto { + name: string; + description?: string | null; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileDetachRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileDetachRequest.ts new file mode 100644 index 00000000..602a1b26 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileDetachRequest.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * fileId: "fileId" + * } + */ +export interface KnowledgeBaseV2ControllerFileDetachRequest { + /** The unique identifier for the resource. */ + id: string; + fileId: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileRetryRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileRetryRequest.ts new file mode 100644 index 00000000..c62bb7e3 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFileRetryRequest.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * fileId: "fileId" + * } + */ +export interface KnowledgeBaseV2ControllerFileRetryRequest { + /** The unique identifier for the resource. */ + id: string; + fileId: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFilesGetRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFilesGetRequest.ts new file mode 100644 index 00000000..dbe74cda --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFilesGetRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface KnowledgeBaseV2ControllerFilesGetRequest { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindAllRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindAllRequest.ts new file mode 100644 index 00000000..154d3a4c --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindAllRequest.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * {} + */ +export interface KnowledgeBaseV2ControllerFindAllRequest { + limit?: number; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindOneRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindOneRequest.ts new file mode 100644 index 00000000..fe503e8c --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface KnowledgeBaseV2ControllerFindOneRequest { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerRemoveRequest.ts b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerRemoveRequest.ts new file mode 100644 index 00000000..3cac5be6 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/KnowledgeBaseV2ControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface KnowledgeBaseV2ControllerRemoveRequest { + /** The unique identifier for the resource. */ + id: string; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/UpdateKnowledgeBaseV2Dto.ts b/src/api/resources/knowledgeBasesV2/client/requests/UpdateKnowledgeBaseV2Dto.ts new file mode 100644 index 00000000..a70d660e --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/UpdateKnowledgeBaseV2Dto.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface UpdateKnowledgeBaseV2Dto { + /** The unique identifier for the resource. */ + id: string; + name?: string; + description?: string | null; +} diff --git a/src/api/resources/knowledgeBasesV2/client/requests/index.ts b/src/api/resources/knowledgeBasesV2/client/requests/index.ts new file mode 100644 index 00000000..35406140 --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/client/requests/index.ts @@ -0,0 +1,9 @@ +export type { AttachKnowledgeBaseV2FileDto } from "./AttachKnowledgeBaseV2FileDto.js"; +export type { CreateKnowledgeBaseV2Dto } from "./CreateKnowledgeBaseV2Dto.js"; +export type { KnowledgeBaseV2ControllerFileDetachRequest } from "./KnowledgeBaseV2ControllerFileDetachRequest.js"; +export type { KnowledgeBaseV2ControllerFileRetryRequest } from "./KnowledgeBaseV2ControllerFileRetryRequest.js"; +export type { KnowledgeBaseV2ControllerFilesGetRequest } from "./KnowledgeBaseV2ControllerFilesGetRequest.js"; +export type { KnowledgeBaseV2ControllerFindAllRequest } from "./KnowledgeBaseV2ControllerFindAllRequest.js"; +export type { KnowledgeBaseV2ControllerFindOneRequest } from "./KnowledgeBaseV2ControllerFindOneRequest.js"; +export type { KnowledgeBaseV2ControllerRemoveRequest } from "./KnowledgeBaseV2ControllerRemoveRequest.js"; +export type { UpdateKnowledgeBaseV2Dto } from "./UpdateKnowledgeBaseV2Dto.js"; diff --git a/src/api/resources/knowledgeBasesV2/exports.ts b/src/api/resources/knowledgeBasesV2/exports.ts new file mode 100644 index 00000000..8564389c --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { KnowledgeBasesV2Client } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/knowledgeBasesV2/index.ts b/src/api/resources/knowledgeBasesV2/index.ts new file mode 100644 index 00000000..914b8c3c --- /dev/null +++ b/src/api/resources/knowledgeBasesV2/index.ts @@ -0,0 +1 @@ +export * from "./client/index.js"; diff --git a/src/api/resources/observabilityScorecard/client/Client.ts b/src/api/resources/observabilityScorecard/client/Client.ts index 6035efa7..8382f71b 100644 --- a/src/api/resources/observabilityScorecard/client/Client.ts +++ b/src/api/resources/observabilityScorecard/client/Client.ts @@ -23,6 +23,8 @@ export class ObservabilityScorecardClient { } /** + * Returns the scorecard identified by its ID. + * * @param {Vapi.ScorecardControllerGetRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -81,6 +83,8 @@ export class ObservabilityScorecardClient { } /** + * Deletes the scorecard identified by its ID. + * * @param {Vapi.ScorecardControllerRemoveRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -144,6 +148,8 @@ export class ObservabilityScorecardClient { } /** + * Updates the scorecard identified by its ID. + * * @param {Vapi.UpdateScorecardDto} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -210,6 +216,8 @@ export class ObservabilityScorecardClient { } /** + * Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param {Vapi.ScorecardControllerGetPaginatedRequest} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -231,6 +239,7 @@ export class ObservabilityScorecardClient { id, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -245,6 +254,7 @@ export class ObservabilityScorecardClient { id, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -293,16 +303,21 @@ export class ObservabilityScorecardClient { } /** + * Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. + * * @param {Vapi.CreateScorecardDto} request * @param {ObservabilityScorecardClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.observabilityScorecard.scorecardControllerCreate({ * metrics: [{ - * structuredOutputId: "structuredOutputId", * conditions: [{ - * "key": "value" - * }] + * type: "comparator", + * comparator: "=", + * value: 1.1, + * points: 1.1 + * }], + * structuredOutputId: "structuredOutputId" * }] * }) */ diff --git a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetPaginatedRequest.ts b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetPaginatedRequest.ts index f9b28ea9..f4772eff 100644 --- a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetPaginatedRequest.ts +++ b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetPaginatedRequest.ts @@ -7,11 +7,14 @@ import type * as Vapi from "../../../../index.js"; * {} */ export interface ScorecardControllerGetPaginatedRequest { + /** Filters scorecards by ID. */ id?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ScorecardControllerGetPaginatedRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ScorecardControllerGetPaginatedRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetRequest.ts b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetRequest.ts index 8b9f3fd9..1fe5f19b 100644 --- a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetRequest.ts +++ b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerGetRequest.ts @@ -7,5 +7,6 @@ * } */ export interface ScorecardControllerGetRequest { + /** The unique identifier of the scorecard. */ id: string; } diff --git a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerRemoveRequest.ts b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerRemoveRequest.ts index f55d5222..d6fb3b11 100644 --- a/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerRemoveRequest.ts +++ b/src/api/resources/observabilityScorecard/client/requests/ScorecardControllerRemoveRequest.ts @@ -7,5 +7,6 @@ * } */ export interface ScorecardControllerRemoveRequest { + /** The unique identifier of the scorecard. */ id: string; } diff --git a/src/api/resources/observabilityScorecard/client/requests/UpdateScorecardDto.ts b/src/api/resources/observabilityScorecard/client/requests/UpdateScorecardDto.ts index f54637cd..0efefff7 100644 --- a/src/api/resources/observabilityScorecard/client/requests/UpdateScorecardDto.ts +++ b/src/api/resources/observabilityScorecard/client/requests/UpdateScorecardDto.ts @@ -9,6 +9,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateScorecardDto { + /** The unique identifier of the scorecard. */ id: string; /** This is the name of the scorecard. It is only for user reference and will not be used for any evaluation. */ name?: string; diff --git a/src/api/resources/observabilityScorecard/types/ScorecardControllerGetPaginatedRequestSortBy.ts b/src/api/resources/observabilityScorecard/types/ScorecardControllerGetPaginatedRequestSortBy.ts new file mode 100644 index 00000000..9fbf395f --- /dev/null +++ b/src/api/resources/observabilityScorecard/types/ScorecardControllerGetPaginatedRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ScorecardControllerGetPaginatedRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ScorecardControllerGetPaginatedRequestSortBy = + (typeof ScorecardControllerGetPaginatedRequestSortBy)[keyof typeof ScorecardControllerGetPaginatedRequestSortBy]; diff --git a/src/api/resources/observabilityScorecard/types/index.ts b/src/api/resources/observabilityScorecard/types/index.ts index 9d265e2b..c9f46043 100644 --- a/src/api/resources/observabilityScorecard/types/index.ts +++ b/src/api/resources/observabilityScorecard/types/index.ts @@ -1 +1,2 @@ +export * from "./ScorecardControllerGetPaginatedRequestSortBy.js"; export * from "./ScorecardControllerGetPaginatedRequestSortOrder.js"; diff --git a/src/api/resources/phoneNumbers/client/Client.ts b/src/api/resources/phoneNumbers/client/Client.ts index a64f47d2..d011c743 100644 --- a/src/api/resources/phoneNumbers/client/Client.ts +++ b/src/api/resources/phoneNumbers/client/Client.ts @@ -23,6 +23,8 @@ export class PhoneNumbersClient { } /** + * Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListPhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -100,6 +102,8 @@ export class PhoneNumbersClient { } /** + * Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. + * * @param {Vapi.CreatePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -161,6 +165,8 @@ export class PhoneNumbersClient { } /** + * Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. + * * @param {Vapi.PhoneNumberControllerFindAllPaginatedRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -184,6 +190,7 @@ export class PhoneNumbersClient { search, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -198,6 +205,7 @@ export class PhoneNumbersClient { search, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -246,6 +254,8 @@ export class PhoneNumbersClient { } /** + * Returns the phone number resource identified by its ID. + * * @param {Vapi.GetPhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -304,6 +314,8 @@ export class PhoneNumbersClient { } /** + * Deletes the phone number resource identified by its ID. + * * @param {Vapi.DeletePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -362,6 +374,8 @@ export class PhoneNumbersClient { } /** + * Updates the specified fields of the phone number resource identified by its ID. + * * @param {Vapi.UpdatePhoneNumbersRequest} request * @param {PhoneNumbersClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/phoneNumbers/client/requests/DeletePhoneNumbersRequest.ts b/src/api/resources/phoneNumbers/client/requests/DeletePhoneNumbersRequest.ts index 28f1cb3d..0794baae 100644 --- a/src/api/resources/phoneNumbers/client/requests/DeletePhoneNumbersRequest.ts +++ b/src/api/resources/phoneNumbers/client/requests/DeletePhoneNumbersRequest.ts @@ -7,5 +7,6 @@ * } */ export interface DeletePhoneNumbersRequest { + /** The unique identifier of the phone number. */ id: string; } diff --git a/src/api/resources/phoneNumbers/client/requests/GetPhoneNumbersRequest.ts b/src/api/resources/phoneNumbers/client/requests/GetPhoneNumbersRequest.ts index 54aa372e..52efadb9 100644 --- a/src/api/resources/phoneNumbers/client/requests/GetPhoneNumbersRequest.ts +++ b/src/api/resources/phoneNumbers/client/requests/GetPhoneNumbersRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetPhoneNumbersRequest { + /** The unique identifier of the phone number. */ id: string; } diff --git a/src/api/resources/phoneNumbers/client/requests/PhoneNumberControllerFindAllPaginatedRequest.ts b/src/api/resources/phoneNumbers/client/requests/PhoneNumberControllerFindAllPaginatedRequest.ts index d109552c..7a926edf 100644 --- a/src/api/resources/phoneNumbers/client/requests/PhoneNumberControllerFindAllPaginatedRequest.ts +++ b/src/api/resources/phoneNumbers/client/requests/PhoneNumberControllerFindAllPaginatedRequest.ts @@ -13,6 +13,8 @@ export interface PhoneNumberControllerFindAllPaginatedRequest { page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.PhoneNumberControllerFindAllPaginatedRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.PhoneNumberControllerFindAllPaginatedRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/phoneNumbers/client/requests/UpdatePhoneNumbersRequest.ts b/src/api/resources/phoneNumbers/client/requests/UpdatePhoneNumbersRequest.ts index 1988f2fe..ac416354 100644 --- a/src/api/resources/phoneNumbers/client/requests/UpdatePhoneNumbersRequest.ts +++ b/src/api/resources/phoneNumbers/client/requests/UpdatePhoneNumbersRequest.ts @@ -12,6 +12,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdatePhoneNumbersRequest { + /** The unique identifier of the phone number. */ id: string; body: Vapi.UpdatePhoneNumbersRequestBody; } diff --git a/src/api/resources/phoneNumbers/types/PhoneNumberControllerFindAllPaginatedRequestSortBy.ts b/src/api/resources/phoneNumbers/types/PhoneNumberControllerFindAllPaginatedRequestSortBy.ts new file mode 100644 index 00000000..fcc8f5ec --- /dev/null +++ b/src/api/resources/phoneNumbers/types/PhoneNumberControllerFindAllPaginatedRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const PhoneNumberControllerFindAllPaginatedRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type PhoneNumberControllerFindAllPaginatedRequestSortBy = + (typeof PhoneNumberControllerFindAllPaginatedRequestSortBy)[keyof typeof PhoneNumberControllerFindAllPaginatedRequestSortBy]; diff --git a/src/api/resources/phoneNumbers/types/index.ts b/src/api/resources/phoneNumbers/types/index.ts index 08dded61..372f0329 100644 --- a/src/api/resources/phoneNumbers/types/index.ts +++ b/src/api/resources/phoneNumbers/types/index.ts @@ -3,6 +3,7 @@ export * from "./CreatePhoneNumbersResponse.js"; export * from "./DeletePhoneNumbersResponse.js"; export * from "./GetPhoneNumbersResponse.js"; export * from "./ListPhoneNumbersResponseItem.js"; +export * from "./PhoneNumberControllerFindAllPaginatedRequestSortBy.js"; export * from "./PhoneNumberControllerFindAllPaginatedRequestSortOrder.js"; export * from "./UpdatePhoneNumbersRequestBody.js"; export * from "./UpdatePhoneNumbersResponse.js"; diff --git a/src/api/resources/providerResources/client/Client.ts b/src/api/resources/providerResources/client/Client.ts index fa3b4af0..1f7fc7d1 100644 --- a/src/api/resources/providerResources/client/Client.ts +++ b/src/api/resources/providerResources/client/Client.ts @@ -23,6 +23,8 @@ export class ProviderResourcesClient { } /** + * Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. + * * @param {Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -52,6 +54,7 @@ export class ProviderResourcesClient { resourceId, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -67,6 +70,7 @@ export class ProviderResourcesClient { resourceId, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -123,6 +127,8 @@ export class ProviderResourcesClient { } /** + * Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + * * @param {Vapi.ProviderResourceControllerCreateProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -189,6 +195,8 @@ export class ProviderResourcesClient { } /** + * Returns the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerGetProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -263,6 +271,8 @@ export class ProviderResourcesClient { } /** + * Deletes the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerDeleteProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -337,6 +347,8 @@ export class ProviderResourcesClient { } /** + * Updates the provider resource identified by its Vapi resource ID. + * * @param {Vapi.ProviderResourceControllerUpdateProviderResourceRequest} request * @param {ProviderResourcesClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/providerResources/client/requests/ProviderResourceControllerDeleteProviderResourceRequest.ts b/src/api/resources/providerResources/client/requests/ProviderResourceControllerDeleteProviderResourceRequest.ts index f07e43cb..a1fe0b65 100644 --- a/src/api/resources/providerResources/client/requests/ProviderResourceControllerDeleteProviderResourceRequest.ts +++ b/src/api/resources/providerResources/client/requests/ProviderResourceControllerDeleteProviderResourceRequest.ts @@ -15,5 +15,6 @@ export interface ProviderResourceControllerDeleteProviderResourceRequest { provider: Vapi.ProviderResourceControllerDeleteProviderResourceRequestProvider; /** The resource name (e.g., pronunciation-dictionary) */ resourceName: Vapi.ProviderResourceControllerDeleteProviderResourceRequestResourceName; + /** The unique identifier of the provider resource. */ id: string; } diff --git a/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourceRequest.ts b/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourceRequest.ts index 5c731f35..975ea5fa 100644 --- a/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourceRequest.ts +++ b/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourceRequest.ts @@ -15,5 +15,6 @@ export interface ProviderResourceControllerGetProviderResourceRequest { provider: Vapi.ProviderResourceControllerGetProviderResourceRequestProvider; /** The resource name (e.g., pronunciation-dictionary) */ resourceName: Vapi.ProviderResourceControllerGetProviderResourceRequestResourceName; + /** The unique identifier of the provider resource. */ id: string; } diff --git a/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourcesPaginatedRequest.ts b/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourcesPaginatedRequest.ts index 4a503051..bfcd404e 100644 --- a/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourcesPaginatedRequest.ts +++ b/src/api/resources/providerResources/client/requests/ProviderResourceControllerGetProviderResourcesPaginatedRequest.ts @@ -14,12 +14,16 @@ export interface ProviderResourceControllerGetProviderResourcesPaginatedRequest provider: Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider; /** The resource name (e.g., pronunciation-dictionary) */ resourceName: Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequestResourceName; + /** Filters provider resources by their resource ID. */ id?: string; + /** Filters provider resources by their provider-specific resource ID. */ resourceId?: string; /** This is the page number to return. Defaults to 1. */ page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/providerResources/client/requests/ProviderResourceControllerUpdateProviderResourceRequest.ts b/src/api/resources/providerResources/client/requests/ProviderResourceControllerUpdateProviderResourceRequest.ts index 996b3639..7c7c0446 100644 --- a/src/api/resources/providerResources/client/requests/ProviderResourceControllerUpdateProviderResourceRequest.ts +++ b/src/api/resources/providerResources/client/requests/ProviderResourceControllerUpdateProviderResourceRequest.ts @@ -15,5 +15,6 @@ export interface ProviderResourceControllerUpdateProviderResourceRequest { provider: Vapi.ProviderResourceControllerUpdateProviderResourceRequestProvider; /** The resource name (e.g., pronunciation-dictionary) */ resourceName: Vapi.ProviderResourceControllerUpdateProviderResourceRequestResourceName; + /** The unique identifier of the provider resource. */ id: string; } diff --git a/src/api/resources/providerResources/types/ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy.ts b/src/api/resources/providerResources/types/ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy.ts new file mode 100644 index 00000000..baa57d5e --- /dev/null +++ b/src/api/resources/providerResources/types/ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy = + (typeof ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy)[keyof typeof ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy]; diff --git a/src/api/resources/providerResources/types/index.ts b/src/api/resources/providerResources/types/index.ts index 0f3af992..223f1e34 100644 --- a/src/api/resources/providerResources/types/index.ts +++ b/src/api/resources/providerResources/types/index.ts @@ -6,6 +6,7 @@ export * from "./ProviderResourceControllerGetProviderResourceRequestProvider.js export * from "./ProviderResourceControllerGetProviderResourceRequestResourceName.js"; export * from "./ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider.js"; export * from "./ProviderResourceControllerGetProviderResourcesPaginatedRequestResourceName.js"; +export * from "./ProviderResourceControllerGetProviderResourcesPaginatedRequestSortBy.js"; export * from "./ProviderResourceControllerGetProviderResourcesPaginatedRequestSortOrder.js"; export * from "./ProviderResourceControllerUpdateProviderResourceRequestProvider.js"; export * from "./ProviderResourceControllerUpdateProviderResourceRequestResourceName.js"; diff --git a/src/api/resources/sessions/client/Client.ts b/src/api/resources/sessions/client/Client.ts index 6e1ce519..744129bc 100644 --- a/src/api/resources/sessions/client/Client.ts +++ b/src/api/resources/sessions/client/Client.ts @@ -55,15 +55,18 @@ export class SessionsClient { numberE164CheckEnabled, extension, assistantOverrides, + squadOverrides, number: number_, sipUri, email, externalId, customerNumberAny, + idAny, phoneNumberId, phoneNumberIdAny, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -84,15 +87,18 @@ export class SessionsClient { numberE164CheckEnabled, extension, assistantOverrides, + squadOverrides, number: number_, sipUri, email, externalId, customerNumberAny, + idAny, phoneNumberId, phoneNumberIdAny, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, diff --git a/src/api/resources/sessions/client/requests/DeleteSessionsRequest.ts b/src/api/resources/sessions/client/requests/DeleteSessionsRequest.ts index 9081b962..d5d6f317 100644 --- a/src/api/resources/sessions/client/requests/DeleteSessionsRequest.ts +++ b/src/api/resources/sessions/client/requests/DeleteSessionsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface DeleteSessionsRequest { + /** The unique identifier for the resource. */ id: string; } diff --git a/src/api/resources/sessions/client/requests/GetSessionsRequest.ts b/src/api/resources/sessions/client/requests/GetSessionsRequest.ts index 6f2e9295..4fe9a153 100644 --- a/src/api/resources/sessions/client/requests/GetSessionsRequest.ts +++ b/src/api/resources/sessions/client/requests/GetSessionsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetSessionsRequest { + /** The unique identifier for the resource. */ id: string; } diff --git a/src/api/resources/sessions/client/requests/ListSessionsRequest.ts b/src/api/resources/sessions/client/requests/ListSessionsRequest.ts index ce87294c..e7cf7c5f 100644 --- a/src/api/resources/sessions/client/requests/ListSessionsRequest.ts +++ b/src/api/resources/sessions/client/requests/ListSessionsRequest.ts @@ -45,6 +45,12 @@ export interface ListSessionsRequest { * This allows customization of the assistant's behavior for individual customers in batch calls. */ assistantOverrides?: string; + /** + * These are the overrides applied when the call targets a `squadId`. Mirrors + * the call-level `squadOverrides` — use this instead of `assistantOverrides` + * when the campaign or call is squad-based. + */ + squadOverrides?: string; /** This is the number of the customer. */ number?: string; /** This is the SIP URI of the customer. */ @@ -55,6 +61,8 @@ export interface ListSessionsRequest { externalId?: string; /** Filter by any of the specified customer phone numbers (comma-separated). */ customerNumberAny?: string; + /** Filter by multiple session IDs. Provide as comma-separated values. */ + idAny?: string; /** This will return sessions with the specified phoneNumberId. */ phoneNumberId?: string; /** This will return sessions with any of the specified phoneNumberIds. */ @@ -63,6 +71,8 @@ export interface ListSessionsRequest { page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ListSessionsRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ListSessionsRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/sessions/client/requests/UpdateSessionDto.ts b/src/api/resources/sessions/client/requests/UpdateSessionDto.ts index 9f3128a3..8f381ae6 100644 --- a/src/api/resources/sessions/client/requests/UpdateSessionDto.ts +++ b/src/api/resources/sessions/client/requests/UpdateSessionDto.ts @@ -9,6 +9,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateSessionDto { + /** The unique identifier for the resource. */ id: string; /** This is the new name for the session. Maximum length is 40 characters. */ name?: string; diff --git a/src/api/resources/sessions/types/ListSessionsRequestSortBy.ts b/src/api/resources/sessions/types/ListSessionsRequestSortBy.ts new file mode 100644 index 00000000..edf53a34 --- /dev/null +++ b/src/api/resources/sessions/types/ListSessionsRequestSortBy.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ListSessionsRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ListSessionsRequestSortBy = (typeof ListSessionsRequestSortBy)[keyof typeof ListSessionsRequestSortBy]; diff --git a/src/api/resources/sessions/types/index.ts b/src/api/resources/sessions/types/index.ts index 15e1abf7..4e4fa34b 100644 --- a/src/api/resources/sessions/types/index.ts +++ b/src/api/resources/sessions/types/index.ts @@ -1,5 +1,6 @@ export * from "./CreateSessionDtoMessagesItem.js"; export * from "./CreateSessionDtoStatus.js"; +export * from "./ListSessionsRequestSortBy.js"; export * from "./ListSessionsRequestSortOrder.js"; export * from "./UpdateSessionDtoMessagesItem.js"; export * from "./UpdateSessionDtoStatus.js"; diff --git a/src/api/resources/simulationPersonalities/client/Client.ts b/src/api/resources/simulationPersonalities/client/Client.ts new file mode 100644 index 00000000..1825b52c --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/Client.ts @@ -0,0 +1,370 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace SimulationPersonalitiesClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class SimulationPersonalitiesClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: SimulationPersonalitiesClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * Returns the personalities for the authenticated organization. + * + * @param {Vapi.PersonalityControllerFindAllRequest} request + * @param {SimulationPersonalitiesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationPersonalities.personalityControllerFindAll() + */ + public personalityControllerFindAll( + request: Vapi.PersonalityControllerFindAllRequest = {}, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__personalityControllerFindAll(request, requestOptions)); + } + + private async __personalityControllerFindAll( + request: Vapi.PersonalityControllerFindAllRequest = {}, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): Promise> { + const { + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/personality", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Personality[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/personality"); + } + + /** + * Creates a personality, the AI tester's configuration used in simulations. + * + * @param {Vapi.CreatePersonalityDto} request + * @param {SimulationPersonalitiesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationPersonalities.personalityControllerCreate({ + * name: "name", + * assistant: {} + * }) + */ + public personalityControllerCreate( + request: Vapi.CreatePersonalityDto, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__personalityControllerCreate(request, requestOptions)); + } + + private async __personalityControllerCreate( + request: Vapi.CreatePersonalityDto, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/personality", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Personality, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/eval/simulation/personality"); + } + + /** + * Returns the specified personality. + * + * @param {Vapi.PersonalityControllerFindOneRequest} request + * @param {SimulationPersonalitiesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationPersonalities.personalityControllerFindOne({ + * id: "id" + * }) + */ + public personalityControllerFindOne( + request: Vapi.PersonalityControllerFindOneRequest, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__personalityControllerFindOne(request, requestOptions)); + } + + private async __personalityControllerFindOne( + request: Vapi.PersonalityControllerFindOneRequest, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/personality/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Personality, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/eval/simulation/personality/{id}", + ); + } + + /** + * Deletes the specified personality. + * + * @param {Vapi.PersonalityControllerRemoveRequest} request + * @param {SimulationPersonalitiesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationPersonalities.personalityControllerRemove({ + * id: "id" + * }) + */ + public personalityControllerRemove( + request: Vapi.PersonalityControllerRemoveRequest, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__personalityControllerRemove(request, requestOptions)); + } + + private async __personalityControllerRemove( + request: Vapi.PersonalityControllerRemoveRequest, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/personality/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Personality, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "DELETE", + "/eval/simulation/personality/{id}", + ); + } + + /** + * Updates the specified personality. Changes apply to future runs. + * + * @param {Vapi.UpdatePersonalityDto} request + * @param {SimulationPersonalitiesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationPersonalities.personalityControllerUpdate({ + * id: "id" + * }) + */ + public personalityControllerUpdate( + request: Vapi.UpdatePersonalityDto, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__personalityControllerUpdate(request, requestOptions)); + } + + private async __personalityControllerUpdate( + request: Vapi.UpdatePersonalityDto, + requestOptions?: SimulationPersonalitiesClient.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/personality/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Personality, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "PATCH", + "/eval/simulation/personality/{id}", + ); + } +} diff --git a/src/api/resources/simulationPersonalities/client/index.ts b/src/api/resources/simulationPersonalities/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindAllRequest.ts b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindAllRequest.ts new file mode 100644 index 00000000..5291966d --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindAllRequest.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface PersonalityControllerFindAllRequest { + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.PersonalityControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.PersonalityControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindOneRequest.ts b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindOneRequest.ts new file mode 100644 index 00000000..56c872fa --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface PersonalityControllerFindOneRequest { + /** The unique identifier of the personality. */ + id: string; +} diff --git a/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerRemoveRequest.ts b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerRemoveRequest.ts new file mode 100644 index 00000000..2399d2ef --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/requests/PersonalityControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface PersonalityControllerRemoveRequest { + /** The unique identifier of the personality. */ + id: string; +} diff --git a/src/api/types/UpdatePersonalityDto.ts b/src/api/resources/simulationPersonalities/client/requests/UpdatePersonalityDto.ts similarity index 60% rename from src/api/types/UpdatePersonalityDto.ts rename to src/api/resources/simulationPersonalities/client/requests/UpdatePersonalityDto.ts index 1cffa8ac..8dc6e204 100644 --- a/src/api/types/UpdatePersonalityDto.ts +++ b/src/api/resources/simulationPersonalities/client/requests/UpdatePersonalityDto.ts @@ -1,16 +1,24 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../../index.js"; +/** + * @example + * { + * id: "id" + * } + */ export interface UpdatePersonalityDto { + /** The unique identifier of the personality. */ + id: string; /** This is the name of the personality. */ - name?: string | undefined; + name?: string; /** This is the full assistant configuration for this personality. */ - assistant?: Vapi.CreateAssistantDto | undefined; + assistant?: Vapi.CreateAssistantDto; /** * Optional folder path for organizing personalities. * Supports up to 3 levels (e.g., "dept/feature/variant"). * Set to null to remove from folder. */ - path?: (string | null) | undefined; + path?: string | null; } diff --git a/src/api/resources/simulationPersonalities/client/requests/index.ts b/src/api/resources/simulationPersonalities/client/requests/index.ts new file mode 100644 index 00000000..5b6249a8 --- /dev/null +++ b/src/api/resources/simulationPersonalities/client/requests/index.ts @@ -0,0 +1,4 @@ +export type { PersonalityControllerFindAllRequest } from "./PersonalityControllerFindAllRequest.js"; +export type { PersonalityControllerFindOneRequest } from "./PersonalityControllerFindOneRequest.js"; +export type { PersonalityControllerRemoveRequest } from "./PersonalityControllerRemoveRequest.js"; +export type { UpdatePersonalityDto } from "./UpdatePersonalityDto.js"; diff --git a/src/api/resources/simulationPersonalities/exports.ts b/src/api/resources/simulationPersonalities/exports.ts new file mode 100644 index 00000000..bd20bfca --- /dev/null +++ b/src/api/resources/simulationPersonalities/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { SimulationPersonalitiesClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/simulationPersonalities/index.ts b/src/api/resources/simulationPersonalities/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/simulationPersonalities/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortBy.ts b/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..4d8cfc32 --- /dev/null +++ b/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const PersonalityControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type PersonalityControllerFindAllRequestSortBy = + (typeof PersonalityControllerFindAllRequestSortBy)[keyof typeof PersonalityControllerFindAllRequestSortBy]; diff --git a/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortOrder.ts b/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..3ea22abc --- /dev/null +++ b/src/api/resources/simulationPersonalities/types/PersonalityControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const PersonalityControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type PersonalityControllerFindAllRequestSortOrder = + (typeof PersonalityControllerFindAllRequestSortOrder)[keyof typeof PersonalityControllerFindAllRequestSortOrder]; diff --git a/src/api/resources/simulationPersonalities/types/index.ts b/src/api/resources/simulationPersonalities/types/index.ts new file mode 100644 index 00000000..00c55ad0 --- /dev/null +++ b/src/api/resources/simulationPersonalities/types/index.ts @@ -0,0 +1,2 @@ +export * from "./PersonalityControllerFindAllRequestSortBy.js"; +export * from "./PersonalityControllerFindAllRequestSortOrder.js"; diff --git a/src/api/resources/simulationRuns/client/Client.ts b/src/api/resources/simulationRuns/client/Client.ts new file mode 100644 index 00000000..febcf3b7 --- /dev/null +++ b/src/api/resources/simulationRuns/client/Client.ts @@ -0,0 +1,621 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import * as Vapi from "../../../index.js"; + +export declare namespace SimulationRunsClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class SimulationRunsClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: SimulationRunsClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * Returns the simulation runs for the authenticated organization. + * + * @param {Vapi.SimulationRunControllerFindAllRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerFindAll() + */ + public simulationRunControllerFindAll( + request: Vapi.SimulationRunControllerFindAllRequest = {}, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerFindAll(request, requestOptions)); + } + + private async __simulationRunControllerFindAll( + request: Vapi.SimulationRunControllerFindAllRequest = {}, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { + status, + filterStatus, + targetType, + targetId, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + status: status != null ? status : undefined, + filterStatus: filterStatus != null ? filterStatus : undefined, + targetType: targetType != null ? targetType : undefined, + targetId, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/run", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { + data: _response.body as Vapi.SimulationRunControllerFindAllResponse, + rawResponse: _response.rawResponse, + }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/run"); + } + + /** + * Starts a simulation run against a target assistant or squad. + * + * @param {Vapi.CreateSimulationRunDto} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @throws {@link Vapi.PaymentRequiredError} + * + * @example + * await client.simulationRuns.simulationRunControllerCreate({ + * simulations: [{ + * type: "simulation" + * }], + * target: { + * type: "assistant" + * } + * }) + */ + public simulationRunControllerCreate( + request: Vapi.CreateSimulationRunDto, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerCreate(request, requestOptions)); + } + + private async __simulationRunControllerCreate( + request: Vapi.CreateSimulationRunDto, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/run", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.CreateSimulationRunResponse, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + switch (_response.error.statusCode) { + case 402: + throw new Vapi.PaymentRequiredError( + _response.error.body as Vapi.SimulationRunPaymentRequiredResponse, + _response.rawResponse, + ); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/eval/simulation/run"); + } + + /** + * Returns the specified simulation run, including its status and item counts. + * + * @param {Vapi.SimulationRunControllerFindOneRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerFindOne({ + * id: "id" + * }) + */ + public simulationRunControllerFindOne( + request: Vapi.SimulationRunControllerFindOneRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerFindOne(request, requestOptions)); + } + + private async __simulationRunControllerFindOne( + request: Vapi.SimulationRunControllerFindOneRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationRun, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/run/{id}"); + } + + /** + * Cancels the specified simulation run. + * + * @param {Vapi.SimulationRunControllerCancelGroupRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerCancelGroup({ + * id: "id" + * }) + */ + public simulationRunControllerCancelGroup( + request: Vapi.SimulationRunControllerCancelGroupRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerCancelGroup(request, requestOptions)); + } + + private async __simulationRunControllerCancelGroup( + request: Vapi.SimulationRunControllerCancelGroupRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationRun, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/eval/simulation/run/{id}"); + } + + /** + * Returns the run items for the specified simulation run. + * + * @param {Vapi.SimulationRunControllerFindItemsRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerFindItems({ + * id: "id" + * }) + */ + public simulationRunControllerFindItems( + request: Vapi.SimulationRunControllerFindItemsRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerFindItems(request, requestOptions)); + } + + private async __simulationRunControllerFindItems( + request: Vapi.SimulationRunControllerFindItemsRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { + id, + simulationId, + runId, + status, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + simulationId, + runId, + status: status != null ? status : undefined, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}/item`, + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationRunItem[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/eval/simulation/run/{id}/item", + ); + } + + /** + * Returns the specified run item, including its evaluation results and the ID of the call that ran it. + * + * @param {Vapi.SimulationRunControllerFindItemRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerFindItem({ + * id: "id", + * itemId: "itemId" + * }) + */ + public simulationRunControllerFindItem( + request: Vapi.SimulationRunControllerFindItemRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerFindItem(request, requestOptions)); + } + + private async __simulationRunControllerFindItem( + request: Vapi.SimulationRunControllerFindItemRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { id, itemId } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}/item/${core.url.encodePathParam(itemId)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationRunItem, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/eval/simulation/run/{id}/item/{itemId}", + ); + } + + /** + * Cancels the specified run item. + * + * @param {Vapi.SimulationRunControllerCancelItemRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerCancelItem({ + * id: "id", + * itemId: "itemId" + * }) + */ + public simulationRunControllerCancelItem( + request: Vapi.SimulationRunControllerCancelItemRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationRunControllerCancelItem(request, requestOptions)); + } + + private async __simulationRunControllerCancelItem( + request: Vapi.SimulationRunControllerCancelItemRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { id, itemId } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}/item/${core.url.encodePathParam(itemId)}`, + ), + method: "PATCH", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationRunItem, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "PATCH", + "/eval/simulation/run/{id}/item/{itemId}", + ); + } + + /** + * Generates AI suggestions for improving the assistant or squad's system prompt, tools, and scenarios, based on the specified run item. + * + * @param {Vapi.SimulationRunControllerGenerateSuggestionsRequest} request + * @param {SimulationRunsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationRuns.simulationRunControllerGenerateSuggestions({ + * id: "id", + * itemId: "itemId", + * force: "force" + * }) + */ + public simulationRunControllerGenerateSuggestions( + request: Vapi.SimulationRunControllerGenerateSuggestionsRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__simulationRunControllerGenerateSuggestions(request, requestOptions), + ); + } + + private async __simulationRunControllerGenerateSuggestions( + request: Vapi.SimulationRunControllerGenerateSuggestionsRequest, + requestOptions?: SimulationRunsClient.RequestOptions, + ): Promise> { + const { id, itemId, force, persist } = request; + const _queryParams: Record = { + force, + persist, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/run/${core.url.encodePathParam(id)}/item/${core.url.encodePathParam(itemId)}/generate`, + ), + method: "POST", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: undefined, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "POST", + "/eval/simulation/run/{id}/item/{itemId}/generate", + ); + } +} diff --git a/src/api/resources/simulationRuns/client/index.ts b/src/api/resources/simulationRuns/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/simulationRuns/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/types/CreateSimulationRunDto.ts b/src/api/resources/simulationRuns/client/requests/CreateSimulationRunDto.ts similarity index 57% rename from src/api/types/CreateSimulationRunDto.ts rename to src/api/resources/simulationRuns/client/requests/CreateSimulationRunDto.ts index fbca4dc6..fe9fff57 100644 --- a/src/api/types/CreateSimulationRunDto.ts +++ b/src/api/resources/simulationRuns/client/requests/CreateSimulationRunDto.ts @@ -1,14 +1,25 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../../index.js"; +/** + * @example + * { + * simulations: [{ + * type: "simulation" + * }], + * target: { + * type: "assistant" + * } + * } + */ export interface CreateSimulationRunDto { /** Array of simulations and/or suites to run */ simulations: Vapi.CreateSimulationRunDtoSimulationsItem[]; /** Target to test against */ target: Vapi.CreateSimulationRunDtoTarget; /** Number of times to run each simulation (default: 1) */ - iterations?: number | undefined; + iterations?: number; /** Transport configuration for the simulation runs */ - transport?: Vapi.SimulationRunTransportConfiguration | undefined; + transport?: Vapi.SimulationRunTransportConfiguration; } diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelGroupRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelGroupRequest.ts new file mode 100644 index 00000000..9ee68e25 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelGroupRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationRunControllerCancelGroupRequest { + /** The unique identifier of the simulation run. */ + id: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelItemRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelItemRequest.ts new file mode 100644 index 00000000..7ff87fe8 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerCancelItemRequest.ts @@ -0,0 +1,15 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * itemId: "itemId" + * } + */ +export interface SimulationRunControllerCancelItemRequest { + /** The unique identifier of the simulation run. */ + id: string; + /** The unique identifier of the run item. */ + itemId: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindAllRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindAllRequest.ts new file mode 100644 index 00000000..c4b3e3d7 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindAllRequest.ts @@ -0,0 +1,42 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface SimulationRunControllerFindAllRequest { + /** Filter by status */ + status?: Vapi.SimulationRunControllerFindAllRequestStatus; + /** Filter by aggregate run result status */ + filterStatus?: Vapi.SimulationRunControllerFindAllRequestFilterStatus; + /** Filter by target type */ + targetType?: Vapi.SimulationRunControllerFindAllRequestTargetType; + /** Filter by target id */ + targetId?: string; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.SimulationRunControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.SimulationRunControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemRequest.ts new file mode 100644 index 00000000..cf1518b9 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemRequest.ts @@ -0,0 +1,15 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * itemId: "itemId" + * } + */ +export interface SimulationRunControllerFindItemRequest { + /** The unique identifier of the simulation run. */ + id: string; + /** The unique identifier of the run item. */ + itemId: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemsRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemsRequest.ts new file mode 100644 index 00000000..43210f00 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindItemsRequest.ts @@ -0,0 +1,44 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationRunControllerFindItemsRequest { + /** The unique identifier of the simulation run. */ + id: string; + /** Filters run items to a specific simulation. */ + simulationId?: string; + /** Filters run items to a specific run. */ + runId?: string; + /** Filters run items by status. */ + status?: Vapi.SimulationRunControllerFindItemsRequestStatus; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.SimulationRunControllerFindItemsRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.SimulationRunControllerFindItemsRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindOneRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindOneRequest.ts new file mode 100644 index 00000000..58b69179 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationRunControllerFindOneRequest { + /** The unique identifier of the simulation run. */ + id: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/SimulationRunControllerGenerateSuggestionsRequest.ts b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerGenerateSuggestionsRequest.ts new file mode 100644 index 00000000..b9064c1a --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/SimulationRunControllerGenerateSuggestionsRequest.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id", + * itemId: "itemId", + * force: "force" + * } + */ +export interface SimulationRunControllerGenerateSuggestionsRequest { + /** The unique identifier of the simulation run. */ + id: string; + /** The unique identifier of the run item. */ + itemId: string; + /** Set to the string `true` to regenerate improvement suggestions even if they already exist. */ + force: string; + persist?: string; +} diff --git a/src/api/resources/simulationRuns/client/requests/index.ts b/src/api/resources/simulationRuns/client/requests/index.ts new file mode 100644 index 00000000..a4f9bed0 --- /dev/null +++ b/src/api/resources/simulationRuns/client/requests/index.ts @@ -0,0 +1,8 @@ +export type { CreateSimulationRunDto } from "./CreateSimulationRunDto.js"; +export type { SimulationRunControllerCancelGroupRequest } from "./SimulationRunControllerCancelGroupRequest.js"; +export type { SimulationRunControllerCancelItemRequest } from "./SimulationRunControllerCancelItemRequest.js"; +export type { SimulationRunControllerFindAllRequest } from "./SimulationRunControllerFindAllRequest.js"; +export type { SimulationRunControllerFindItemRequest } from "./SimulationRunControllerFindItemRequest.js"; +export type { SimulationRunControllerFindItemsRequest } from "./SimulationRunControllerFindItemsRequest.js"; +export type { SimulationRunControllerFindOneRequest } from "./SimulationRunControllerFindOneRequest.js"; +export type { SimulationRunControllerGenerateSuggestionsRequest } from "./SimulationRunControllerGenerateSuggestionsRequest.js"; diff --git a/src/api/resources/simulationRuns/exports.ts b/src/api/resources/simulationRuns/exports.ts new file mode 100644 index 00000000..73b1e5ed --- /dev/null +++ b/src/api/resources/simulationRuns/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { SimulationRunsClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/simulationRuns/index.ts b/src/api/resources/simulationRuns/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/simulationRuns/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/types/CreateSimulationRunDtoSimulationsItem.ts b/src/api/resources/simulationRuns/types/CreateSimulationRunDtoSimulationsItem.ts similarity index 58% rename from src/api/types/CreateSimulationRunDtoSimulationsItem.ts rename to src/api/resources/simulationRuns/types/CreateSimulationRunDtoSimulationsItem.ts index 467e3a29..b7b27ce3 100644 --- a/src/api/types/CreateSimulationRunDtoSimulationsItem.ts +++ b/src/api/resources/simulationRuns/types/CreateSimulationRunDtoSimulationsItem.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../index.js"; export type CreateSimulationRunDtoSimulationsItem = | Vapi.CreateSimulationRunDtoSimulationsItem.Simulation @@ -14,4 +14,11 @@ export namespace CreateSimulationRunDtoSimulationsItem { export interface SimulationSuite extends Vapi.SimulationRunSuiteEntry { type: "simulationSuite"; } + + export type Request = + | Vapi.CreateSimulationRunDtoSimulationsItem.Simulation + | Vapi.CreateSimulationRunDtoSimulationsItem.SimulationSuite; + export type Response = + | Vapi.CreateSimulationRunDtoSimulationsItem.Simulation + | Vapi.CreateSimulationRunDtoSimulationsItem.SimulationSuite; } diff --git a/src/api/types/CreateSimulationRunDtoTarget.ts b/src/api/resources/simulationRuns/types/CreateSimulationRunDtoTarget.ts similarity index 70% rename from src/api/types/CreateSimulationRunDtoTarget.ts rename to src/api/resources/simulationRuns/types/CreateSimulationRunDtoTarget.ts index 392cb798..d1eb1d18 100644 --- a/src/api/types/CreateSimulationRunDtoTarget.ts +++ b/src/api/resources/simulationRuns/types/CreateSimulationRunDtoTarget.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../index.js"; /** * Target to test against @@ -17,4 +17,9 @@ export namespace CreateSimulationRunDtoTarget { export interface Squad extends Vapi.SimulationRunTargetSquad { type: "squad"; } + + /** + * Target to test against + */ + export type Response = Vapi.CreateSimulationRunDtoTarget.Assistant | Vapi.CreateSimulationRunDtoTarget.Squad; } diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestFilterStatus.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestFilterStatus.ts new file mode 100644 index 00000000..10891522 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestFilterStatus.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindAllRequestFilterStatus = { + Passed: "passed", + Failed: "failed", + Running: "running", +} as const; +export type SimulationRunControllerFindAllRequestFilterStatus = + (typeof SimulationRunControllerFindAllRequestFilterStatus)[keyof typeof SimulationRunControllerFindAllRequestFilterStatus]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortBy.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..feb4b903 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type SimulationRunControllerFindAllRequestSortBy = + (typeof SimulationRunControllerFindAllRequestSortBy)[keyof typeof SimulationRunControllerFindAllRequestSortBy]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortOrder.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..92e5ba3a --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type SimulationRunControllerFindAllRequestSortOrder = + (typeof SimulationRunControllerFindAllRequestSortOrder)[keyof typeof SimulationRunControllerFindAllRequestSortOrder]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestStatus.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestStatus.ts new file mode 100644 index 00000000..bb8b0a38 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestStatus.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindAllRequestStatus = { + Queued: "queued", + Running: "running", + Ended: "ended", +} as const; +export type SimulationRunControllerFindAllRequestStatus = + (typeof SimulationRunControllerFindAllRequestStatus)[keyof typeof SimulationRunControllerFindAllRequestStatus]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestTargetType.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestTargetType.ts new file mode 100644 index 00000000..1010b948 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllRequestTargetType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindAllRequestTargetType = { + Assistant: "assistant", + Squad: "squad", +} as const; +export type SimulationRunControllerFindAllRequestTargetType = + (typeof SimulationRunControllerFindAllRequestTargetType)[keyof typeof SimulationRunControllerFindAllRequestTargetType]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllResponse.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllResponse.ts new file mode 100644 index 00000000..829f78a6 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindAllResponse.ts @@ -0,0 +1,5 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export type SimulationRunControllerFindAllResponse = Vapi.SimulationRun[] | Vapi.SimulationRunsPaginatedResponse; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortBy.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortBy.ts new file mode 100644 index 00000000..58e89a93 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindItemsRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type SimulationRunControllerFindItemsRequestSortBy = + (typeof SimulationRunControllerFindItemsRequestSortBy)[keyof typeof SimulationRunControllerFindItemsRequestSortBy]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortOrder.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortOrder.ts new file mode 100644 index 00000000..ddb5a25f --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindItemsRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type SimulationRunControllerFindItemsRequestSortOrder = + (typeof SimulationRunControllerFindItemsRequestSortOrder)[keyof typeof SimulationRunControllerFindItemsRequestSortOrder]; diff --git a/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestStatus.ts b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestStatus.ts new file mode 100644 index 00000000..a39de778 --- /dev/null +++ b/src/api/resources/simulationRuns/types/SimulationRunControllerFindItemsRequestStatus.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunControllerFindItemsRequestStatus = { + Queued: "queued", + Running: "running", + Evaluating: "evaluating", + Passed: "passed", + Failed: "failed", + Canceled: "canceled", +} as const; +export type SimulationRunControllerFindItemsRequestStatus = + (typeof SimulationRunControllerFindItemsRequestStatus)[keyof typeof SimulationRunControllerFindItemsRequestStatus]; diff --git a/src/api/resources/simulationRuns/types/index.ts b/src/api/resources/simulationRuns/types/index.ts new file mode 100644 index 00000000..624ded58 --- /dev/null +++ b/src/api/resources/simulationRuns/types/index.ts @@ -0,0 +1,11 @@ +export * from "./CreateSimulationRunDtoSimulationsItem.js"; +export * from "./CreateSimulationRunDtoTarget.js"; +export * from "./SimulationRunControllerFindAllRequestFilterStatus.js"; +export * from "./SimulationRunControllerFindAllRequestSortBy.js"; +export * from "./SimulationRunControllerFindAllRequestSortOrder.js"; +export * from "./SimulationRunControllerFindAllRequestStatus.js"; +export * from "./SimulationRunControllerFindAllRequestTargetType.js"; +export * from "./SimulationRunControllerFindAllResponse.js"; +export * from "./SimulationRunControllerFindItemsRequestSortBy.js"; +export * from "./SimulationRunControllerFindItemsRequestSortOrder.js"; +export * from "./SimulationRunControllerFindItemsRequestStatus.js"; diff --git a/src/api/resources/simulationScenarios/client/Client.ts b/src/api/resources/simulationScenarios/client/Client.ts new file mode 100644 index 00000000..ca925c6c --- /dev/null +++ b/src/api/resources/simulationScenarios/client/Client.ts @@ -0,0 +1,378 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace SimulationScenariosClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class SimulationScenariosClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: SimulationScenariosClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * Returns the scenarios for the authenticated organization. + * + * @param {Vapi.ScenarioControllerFindAllRequest} request + * @param {SimulationScenariosClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationScenarios.scenarioControllerFindAll() + */ + public scenarioControllerFindAll( + request: Vapi.ScenarioControllerFindAllRequest = {}, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__scenarioControllerFindAll(request, requestOptions)); + } + + private async __scenarioControllerFindAll( + request: Vapi.ScenarioControllerFindAllRequest = {}, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): Promise> { + const { + idAny, + name, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + idAny, + name, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/scenario", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Scenario[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/scenario"); + } + + /** + * Creates a scenario, the AI tester's intent plus the success criteria that score a run. + * + * @param {Vapi.CreateScenarioDto} request + * @param {SimulationScenariosClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationScenarios.scenarioControllerCreate({ + * name: "Health Enrollment - Eligible Path", + * instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + * evaluations: [{ + * comparator: "=", + * value: 1.1 + * }] + * }) + */ + public scenarioControllerCreate( + request: Vapi.CreateScenarioDto, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__scenarioControllerCreate(request, requestOptions)); + } + + private async __scenarioControllerCreate( + request: Vapi.CreateScenarioDto, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/scenario", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Scenario, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/eval/simulation/scenario"); + } + + /** + * Returns the specified scenario. + * + * @param {Vapi.ScenarioControllerFindOneRequest} request + * @param {SimulationScenariosClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationScenarios.scenarioControllerFindOne({ + * id: "id" + * }) + */ + public scenarioControllerFindOne( + request: Vapi.ScenarioControllerFindOneRequest, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__scenarioControllerFindOne(request, requestOptions)); + } + + private async __scenarioControllerFindOne( + request: Vapi.ScenarioControllerFindOneRequest, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/scenario/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Scenario, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "GET", + "/eval/simulation/scenario/{id}", + ); + } + + /** + * Deletes the specified scenario. + * + * @param {Vapi.ScenarioControllerRemoveRequest} request + * @param {SimulationScenariosClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationScenarios.scenarioControllerRemove({ + * id: "id" + * }) + */ + public scenarioControllerRemove( + request: Vapi.ScenarioControllerRemoveRequest, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__scenarioControllerRemove(request, requestOptions)); + } + + private async __scenarioControllerRemove( + request: Vapi.ScenarioControllerRemoveRequest, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/scenario/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Scenario, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "DELETE", + "/eval/simulation/scenario/{id}", + ); + } + + /** + * Updates the specified scenario. + * + * @param {Vapi.UpdateScenarioDto} request + * @param {SimulationScenariosClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationScenarios.scenarioControllerUpdate({ + * id: "id" + * }) + */ + public scenarioControllerUpdate( + request: Vapi.UpdateScenarioDto, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__scenarioControllerUpdate(request, requestOptions)); + } + + private async __scenarioControllerUpdate( + request: Vapi.UpdateScenarioDto, + requestOptions?: SimulationScenariosClient.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/scenario/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Scenario, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "PATCH", + "/eval/simulation/scenario/{id}", + ); + } +} diff --git a/src/api/resources/simulationScenarios/client/index.ts b/src/api/resources/simulationScenarios/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/simulationScenarios/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindAllRequest.ts b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindAllRequest.ts new file mode 100644 index 00000000..f20c381a --- /dev/null +++ b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindAllRequest.ts @@ -0,0 +1,38 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface ScenarioControllerFindAllRequest { + /** Return only scenarios matching the provided ids */ + idAny?: string | string[]; + /** Search by scenario name */ + name?: string; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.ScenarioControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ScenarioControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindOneRequest.ts b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindOneRequest.ts new file mode 100644 index 00000000..dd382053 --- /dev/null +++ b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface ScenarioControllerFindOneRequest { + /** The unique identifier of the scenario. */ + id: string; +} diff --git a/src/api/resources/simulationScenarios/client/requests/ScenarioControllerRemoveRequest.ts b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerRemoveRequest.ts new file mode 100644 index 00000000..e85833a4 --- /dev/null +++ b/src/api/resources/simulationScenarios/client/requests/ScenarioControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface ScenarioControllerRemoveRequest { + /** The unique identifier of the scenario. */ + id: string; +} diff --git a/src/api/types/UpdateScenarioDto.ts b/src/api/resources/simulationScenarios/client/requests/UpdateScenarioDto.ts similarity index 63% rename from src/api/types/UpdateScenarioDto.ts rename to src/api/resources/simulationScenarios/client/requests/UpdateScenarioDto.ts index 84db66ac..8adfa0a9 100644 --- a/src/api/types/UpdateScenarioDto.ts +++ b/src/api/resources/simulationScenarios/client/requests/UpdateScenarioDto.ts @@ -1,26 +1,34 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../../index.js"; +/** + * @example + * { + * id: "id" + * } + */ export interface UpdateScenarioDto { + /** The unique identifier of the scenario. */ + id: string; /** This is the name of the scenario. */ - name?: string | undefined; + name?: string; /** This is the script/instructions for the tester to follow during the simulation. */ - instructions?: string | undefined; + instructions?: string; /** * This is the structured output-based evaluation plan for the simulation. * Each item defines a structured output to extract and evaluate against an expected value. */ - evaluations?: Vapi.EvaluationPlanItem[] | undefined; + evaluations?: Vapi.EvaluationPlanItem[]; /** Hooks to run on simulation lifecycle events */ - hooks?: Vapi.UpdateScenarioDtoHooksItem[] | undefined; + hooks?: Vapi.UpdateScenarioDtoHooksItem[]; /** Overrides to inject into the simulated target assistant or squad */ - targetOverrides?: Vapi.AssistantOverrides | undefined; - toolMocks?: Vapi.ScenarioToolMock[] | undefined; + targetOverrides?: Vapi.AssistantOverrides; + toolMocks?: Vapi.ScenarioToolMock[]; /** * Optional folder path for organizing scenarios. * Supports up to 3 levels (e.g., "dept/feature/variant"). * Set to null to remove from folder. */ - path?: (string | null) | undefined; + path?: string | null; } diff --git a/src/api/resources/simulationScenarios/client/requests/index.ts b/src/api/resources/simulationScenarios/client/requests/index.ts new file mode 100644 index 00000000..538da503 --- /dev/null +++ b/src/api/resources/simulationScenarios/client/requests/index.ts @@ -0,0 +1,4 @@ +export type { ScenarioControllerFindAllRequest } from "./ScenarioControllerFindAllRequest.js"; +export type { ScenarioControllerFindOneRequest } from "./ScenarioControllerFindOneRequest.js"; +export type { ScenarioControllerRemoveRequest } from "./ScenarioControllerRemoveRequest.js"; +export type { UpdateScenarioDto } from "./UpdateScenarioDto.js"; diff --git a/src/api/resources/simulationScenarios/exports.ts b/src/api/resources/simulationScenarios/exports.ts new file mode 100644 index 00000000..691a4a53 --- /dev/null +++ b/src/api/resources/simulationScenarios/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { SimulationScenariosClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/simulationScenarios/index.ts b/src/api/resources/simulationScenarios/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/simulationScenarios/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortBy.ts b/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..9c4ccb1e --- /dev/null +++ b/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ScenarioControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ScenarioControllerFindAllRequestSortBy = + (typeof ScenarioControllerFindAllRequestSortBy)[keyof typeof ScenarioControllerFindAllRequestSortBy]; diff --git a/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortOrder.ts b/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..c2acf714 --- /dev/null +++ b/src/api/resources/simulationScenarios/types/ScenarioControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ScenarioControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type ScenarioControllerFindAllRequestSortOrder = + (typeof ScenarioControllerFindAllRequestSortOrder)[keyof typeof ScenarioControllerFindAllRequestSortOrder]; diff --git a/src/api/types/UpdateScenarioDtoHooksItem.ts b/src/api/resources/simulationScenarios/types/UpdateScenarioDtoHooksItem.ts similarity index 91% rename from src/api/types/UpdateScenarioDtoHooksItem.ts rename to src/api/resources/simulationScenarios/types/UpdateScenarioDtoHooksItem.ts index b5341d15..bd34350b 100644 --- a/src/api/types/UpdateScenarioDtoHooksItem.ts +++ b/src/api/resources/simulationScenarios/types/UpdateScenarioDtoHooksItem.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; +import type * as Vapi from "../../../index.js"; export type UpdateScenarioDtoHooksItem = | Vapi.UpdateScenarioDtoHooksItem.SimulationRunStarted diff --git a/src/api/resources/simulationScenarios/types/index.ts b/src/api/resources/simulationScenarios/types/index.ts new file mode 100644 index 00000000..2b5a295b --- /dev/null +++ b/src/api/resources/simulationScenarios/types/index.ts @@ -0,0 +1,3 @@ +export * from "./ScenarioControllerFindAllRequestSortBy.js"; +export * from "./ScenarioControllerFindAllRequestSortOrder.js"; +export * from "./UpdateScenarioDtoHooksItem.js"; diff --git a/src/api/resources/simulationSuites/client/Client.ts b/src/api/resources/simulationSuites/client/Client.ts new file mode 100644 index 00000000..a67c4d16 --- /dev/null +++ b/src/api/resources/simulationSuites/client/Client.ts @@ -0,0 +1,362 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace SimulationSuitesClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class SimulationSuitesClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: SimulationSuitesClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * Returns the simulation suites for the authenticated organization. + * + * @param {Vapi.SimulationSuiteControllerFindAllRequest} request + * @param {SimulationSuitesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationSuites.simulationSuiteControllerFindAll() + */ + public simulationSuiteControllerFindAll( + request: Vapi.SimulationSuiteControllerFindAllRequest = {}, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationSuiteControllerFindAll(request, requestOptions)); + } + + private async __simulationSuiteControllerFindAll( + request: Vapi.SimulationSuiteControllerFindAllRequest = {}, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): Promise> { + const { + name, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + name, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/suite", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationSuite[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/suite"); + } + + /** + * Creates a simulation suite, a group of simulations that run together. + * + * @param {Vapi.CreateSimulationSuiteDto} request + * @param {SimulationSuitesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationSuites.simulationSuiteControllerCreate({ + * name: "Checkout Flow Tests", + * simulationIds: ["simulationIds"] + * }) + */ + public simulationSuiteControllerCreate( + request: Vapi.CreateSimulationSuiteDto, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationSuiteControllerCreate(request, requestOptions)); + } + + private async __simulationSuiteControllerCreate( + request: Vapi.CreateSimulationSuiteDto, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/suite", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationSuite, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/eval/simulation/suite"); + } + + /** + * Returns the specified simulation suite. + * + * @param {Vapi.SimulationSuiteControllerFindOneRequest} request + * @param {SimulationSuitesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationSuites.simulationSuiteControllerFindOne({ + * id: "id" + * }) + */ + public simulationSuiteControllerFindOne( + request: Vapi.SimulationSuiteControllerFindOneRequest, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationSuiteControllerFindOne(request, requestOptions)); + } + + private async __simulationSuiteControllerFindOne( + request: Vapi.SimulationSuiteControllerFindOneRequest, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/suite/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationSuite, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/suite/{id}"); + } + + /** + * Deletes the specified simulation suite. + * + * @param {Vapi.SimulationSuiteControllerRemoveRequest} request + * @param {SimulationSuitesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationSuites.simulationSuiteControllerRemove({ + * id: "id" + * }) + */ + public simulationSuiteControllerRemove( + request: Vapi.SimulationSuiteControllerRemoveRequest, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationSuiteControllerRemove(request, requestOptions)); + } + + private async __simulationSuiteControllerRemove( + request: Vapi.SimulationSuiteControllerRemoveRequest, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/suite/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationSuite, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "DELETE", + "/eval/simulation/suite/{id}", + ); + } + + /** + * Updates the specified simulation suite. + * + * @param {Vapi.UpdateSimulationSuiteDto} request + * @param {SimulationSuitesClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulationSuites.simulationSuiteControllerUpdate({ + * id: "id" + * }) + */ + public simulationSuiteControllerUpdate( + request: Vapi.UpdateSimulationSuiteDto, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationSuiteControllerUpdate(request, requestOptions)); + } + + private async __simulationSuiteControllerUpdate( + request: Vapi.UpdateSimulationSuiteDto, + requestOptions?: SimulationSuitesClient.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/suite/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationSuite, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/eval/simulation/suite/{id}"); + } +} diff --git a/src/api/resources/simulationSuites/client/index.ts b/src/api/resources/simulationSuites/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/simulationSuites/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/resources/simulationSuites/client/requests/CreateSimulationSuiteDto.ts b/src/api/resources/simulationSuites/client/requests/CreateSimulationSuiteDto.ts new file mode 100644 index 00000000..e55fe085 --- /dev/null +++ b/src/api/resources/simulationSuites/client/requests/CreateSimulationSuiteDto.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * name: "Checkout Flow Tests", + * simulationIds: ["simulationIds"] + * } + */ +export interface CreateSimulationSuiteDto { + /** The display name of the suite. */ + name: string; + /** A Slack incoming-webhook URL notified when the suite runs. */ + slackWebhookUrl?: string; + /** The IDs of the simulations included in the suite. */ + simulationIds: string[]; + /** The assistants or squads the suite's simulations run against. */ + targetAssignments?: Vapi.SimulationSuiteTargetAssignment[]; + /** + * Optional folder path for organizing simulation suites. + * Supports up to 3 levels (e.g., "dept/feature/variant"). + * Maps to GitOps resource folder structure. + */ + path?: string | null; +} diff --git a/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindAllRequest.ts b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindAllRequest.ts new file mode 100644 index 00000000..a68130df --- /dev/null +++ b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindAllRequest.ts @@ -0,0 +1,36 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface SimulationSuiteControllerFindAllRequest { + /** Search by simulation suite name */ + name?: string; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.SimulationSuiteControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.SimulationSuiteControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindOneRequest.ts b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindOneRequest.ts new file mode 100644 index 00000000..d074e298 --- /dev/null +++ b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationSuiteControllerFindOneRequest { + /** The unique identifier of the simulation suite. */ + id: string; +} diff --git a/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerRemoveRequest.ts b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerRemoveRequest.ts new file mode 100644 index 00000000..113f7eda --- /dev/null +++ b/src/api/resources/simulationSuites/client/requests/SimulationSuiteControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationSuiteControllerRemoveRequest { + /** The unique identifier of the simulation suite. */ + id: string; +} diff --git a/src/api/types/UpdateSimulationSuiteDto.ts b/src/api/resources/simulationSuites/client/requests/UpdateSimulationSuiteDto.ts similarity index 54% rename from src/api/types/UpdateSimulationSuiteDto.ts rename to src/api/resources/simulationSuites/client/requests/UpdateSimulationSuiteDto.ts index 2848a94f..74bc0d80 100644 --- a/src/api/types/UpdateSimulationSuiteDto.ts +++ b/src/api/resources/simulationSuites/client/requests/UpdateSimulationSuiteDto.ts @@ -1,16 +1,28 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * { + * id: "id" + * } + */ export interface UpdateSimulationSuiteDto { + /** The unique identifier of the simulation suite. */ + id: string; /** This is the name of the simulation suite. */ - name?: string | undefined; + name?: string; /** This is the Slack webhook URL for notifications. */ - slackWebhookUrl?: string | undefined; + slackWebhookUrl?: string; /** This is the list of simulation IDs to include in the suite (replaces existing). */ - simulationIds?: string[] | undefined; + simulationIds?: string[]; + /** Optional assistant or squad assignments (replaces existing). */ + targetAssignments?: Vapi.SimulationSuiteTargetAssignment[]; /** * Optional folder path for organizing simulation suites. * Supports up to 3 levels (e.g., "dept/feature/variant"). * Set to null to remove from folder. */ - path?: (string | null) | undefined; + path?: string | null; } diff --git a/src/api/resources/simulationSuites/client/requests/index.ts b/src/api/resources/simulationSuites/client/requests/index.ts new file mode 100644 index 00000000..005b3f61 --- /dev/null +++ b/src/api/resources/simulationSuites/client/requests/index.ts @@ -0,0 +1,5 @@ +export type { CreateSimulationSuiteDto } from "./CreateSimulationSuiteDto.js"; +export type { SimulationSuiteControllerFindAllRequest } from "./SimulationSuiteControllerFindAllRequest.js"; +export type { SimulationSuiteControllerFindOneRequest } from "./SimulationSuiteControllerFindOneRequest.js"; +export type { SimulationSuiteControllerRemoveRequest } from "./SimulationSuiteControllerRemoveRequest.js"; +export type { UpdateSimulationSuiteDto } from "./UpdateSimulationSuiteDto.js"; diff --git a/src/api/resources/simulationSuites/exports.ts b/src/api/resources/simulationSuites/exports.ts new file mode 100644 index 00000000..b70f2cdb --- /dev/null +++ b/src/api/resources/simulationSuites/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { SimulationSuitesClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/simulationSuites/index.ts b/src/api/resources/simulationSuites/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/simulationSuites/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortBy.ts b/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..2731d2a0 --- /dev/null +++ b/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationSuiteControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type SimulationSuiteControllerFindAllRequestSortBy = + (typeof SimulationSuiteControllerFindAllRequestSortBy)[keyof typeof SimulationSuiteControllerFindAllRequestSortBy]; diff --git a/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortOrder.ts b/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..6b3bf88d --- /dev/null +++ b/src/api/resources/simulationSuites/types/SimulationSuiteControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationSuiteControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type SimulationSuiteControllerFindAllRequestSortOrder = + (typeof SimulationSuiteControllerFindAllRequestSortOrder)[keyof typeof SimulationSuiteControllerFindAllRequestSortOrder]; diff --git a/src/api/resources/simulationSuites/types/index.ts b/src/api/resources/simulationSuites/types/index.ts new file mode 100644 index 00000000..9053f260 --- /dev/null +++ b/src/api/resources/simulationSuites/types/index.ts @@ -0,0 +1,2 @@ +export * from "./SimulationSuiteControllerFindAllRequestSortBy.js"; +export * from "./SimulationSuiteControllerFindAllRequestSortOrder.js"; diff --git a/src/api/resources/simulations/client/Client.ts b/src/api/resources/simulations/client/Client.ts new file mode 100644 index 00000000..62e83cee --- /dev/null +++ b/src/api/resources/simulations/client/Client.ts @@ -0,0 +1,480 @@ +// This file was auto-generated by Fern from our API Definition. + +import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; +import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js"; +import { mergeHeaders } from "../../../../core/headers.js"; +import * as core from "../../../../core/index.js"; +import * as environments from "../../../../environments.js"; +import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; +import * as errors from "../../../../errors/index.js"; +import type * as Vapi from "../../../index.js"; + +export declare namespace SimulationsClient { + export type Options = BaseClientOptions; + + export interface RequestOptions extends BaseRequestOptions {} +} + +export class SimulationsClient { + protected readonly _options: NormalizedClientOptionsWithAuth; + + constructor(options: SimulationsClient.Options) { + this._options = normalizeClientOptionsWithAuth(options); + } + + /** + * Generates scenarios for an assistant or squad by analyzing its configuration with AI. + * + * @param {Vapi.GenerateScenariosDto} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationGenerateControllerGenerate() + */ + public simulationGenerateControllerGenerate( + request: Vapi.GenerateScenariosDto = {}, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise( + this.__simulationGenerateControllerGenerate(request, requestOptions), + ); + } + + private async __simulationGenerateControllerGenerate( + request: Vapi.GenerateScenariosDto = {}, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/scenario/generate", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.GenerateScenariosResponse, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError( + _response.error, + _response.rawResponse, + "POST", + "/eval/simulation/scenario/generate", + ); + } + + /** + * Returns the simulations for the authenticated organization. + * + * @param {Vapi.SimulationControllerFindAllRequest} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerFindAll() + */ + public simulationControllerFindAll( + request: Vapi.SimulationControllerFindAllRequest = {}, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerFindAll(request, requestOptions)); + } + + private async __simulationControllerFindAll( + request: Vapi.SimulationControllerFindAllRequest = {}, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const { + idAny, + standaloneOnly, + page, + sortOrder, + sortBy, + limit, + createdAtGt, + createdAtLt, + createdAtGe, + createdAtLe, + updatedAtGt, + updatedAtLt, + updatedAtGe, + updatedAtLe, + } = request; + const _queryParams: Record = { + idAny, + standaloneOnly, + page, + sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, + limit, + createdAtGt: createdAtGt != null ? createdAtGt : undefined, + createdAtLt: createdAtLt != null ? createdAtLt : undefined, + createdAtGe: createdAtGe != null ? createdAtGe : undefined, + createdAtLe: createdAtLe != null ? createdAtLe : undefined, + updatedAtGt: updatedAtGt != null ? updatedAtGt : undefined, + updatedAtLt: updatedAtLt != null ? updatedAtLt : undefined, + updatedAtGe: updatedAtGe != null ? updatedAtGe : undefined, + updatedAtLe: updatedAtLe != null ? updatedAtLe : undefined, + }; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation", + ), + method: "GET", + headers: _headers, + queryParameters: { ..._queryParams, ...requestOptions?.queryParams }, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Simulation[], rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation"); + } + + /** + * Creates a simulation by pairing a scenario with a personality. + * + * @param {Vapi.CreateSimulationDto} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerCreate({ + * scenarioId: "scenarioId", + * personalityId: "personalityId" + * }) + */ + public simulationControllerCreate( + request: Vapi.CreateSimulationDto, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerCreate(request, requestOptions)); + } + + private async __simulationControllerCreate( + request: Vapi.CreateSimulationDto, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation", + ), + method: "POST", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: request, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Simulation, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/eval/simulation"); + } + + /** + * Returns the specified simulation. + * + * @param {Vapi.SimulationControllerFindOneRequest} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerFindOne({ + * id: "id" + * }) + */ + public simulationControllerFindOne( + request: Vapi.SimulationControllerFindOneRequest, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerFindOne(request, requestOptions)); + } + + private async __simulationControllerFindOne( + request: Vapi.SimulationControllerFindOneRequest, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/${core.url.encodePathParam(id)}`, + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Simulation, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/{id}"); + } + + /** + * Deletes the specified simulation. + * + * @param {Vapi.SimulationControllerRemoveRequest} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerRemove({ + * id: "id" + * }) + */ + public simulationControllerRemove( + request: Vapi.SimulationControllerRemoveRequest, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerRemove(request, requestOptions)); + } + + private async __simulationControllerRemove( + request: Vapi.SimulationControllerRemoveRequest, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const { id } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/${core.url.encodePathParam(id)}`, + ), + method: "DELETE", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Simulation, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/eval/simulation/{id}"); + } + + /** + * Updates the specified simulation. + * + * @param {Vapi.UpdateSimulationDto} request + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerUpdate({ + * id: "id" + * }) + */ + public simulationControllerUpdate( + request: Vapi.UpdateSimulationDto, + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerUpdate(request, requestOptions)); + } + + private async __simulationControllerUpdate( + request: Vapi.UpdateSimulationDto, + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const { id, ..._body } = request; + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + `eval/simulation/${core.url.encodePathParam(id)}`, + ), + method: "PATCH", + headers: _headers, + contentType: "application/json", + queryParameters: requestOptions?.queryParams, + requestType: "json", + body: _body, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.Simulation, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/eval/simulation/{id}"); + } + + /** + * Returns the organization's simulation concurrency limit, the number of active simulations, and how many more can start. + * + * @param {SimulationsClient.RequestOptions} requestOptions - Request-specific configuration. + * + * @example + * await client.simulations.simulationControllerGetConcurrency() + */ + public simulationControllerGetConcurrency( + requestOptions?: SimulationsClient.RequestOptions, + ): core.HttpResponsePromise { + return core.HttpResponsePromise.fromPromise(this.__simulationControllerGetConcurrency(requestOptions)); + } + + private async __simulationControllerGetConcurrency( + requestOptions?: SimulationsClient.RequestOptions, + ): Promise> { + const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); + const _headers: core.Fetcher.Args["headers"] = mergeHeaders( + _authRequest.headers, + this._options?.headers, + requestOptions?.headers, + ); + const _response = await (this._options.fetcher ?? core.fetcher)({ + url: core.url.join( + (await core.Supplier.get(this._options.baseUrl)) ?? + (await core.Supplier.get(this._options.environment)) ?? + environments.VapiEnvironment.Default, + "eval/simulation/concurrency", + ), + method: "GET", + headers: _headers, + queryParameters: requestOptions?.queryParams, + timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000, + maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries, + abortSignal: requestOptions?.abortSignal, + fetchFn: this._options?.fetch, + logging: this._options.logging, + }); + if (_response.ok) { + return { data: _response.body as Vapi.SimulationConcurrencyResponse, rawResponse: _response.rawResponse }; + } + + if (_response.error.reason === "status-code") { + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } + + return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/eval/simulation/concurrency"); + } +} diff --git a/src/api/resources/simulations/client/index.ts b/src/api/resources/simulations/client/index.ts new file mode 100644 index 00000000..195f9aa8 --- /dev/null +++ b/src/api/resources/simulations/client/index.ts @@ -0,0 +1 @@ +export * from "./requests/index.js"; diff --git a/src/api/types/CreateSimulationDto.ts b/src/api/resources/simulations/client/requests/CreateSimulationDto.ts similarity index 52% rename from src/api/types/CreateSimulationDto.ts rename to src/api/resources/simulations/client/requests/CreateSimulationDto.ts index d1e3c701..ed0e2e30 100644 --- a/src/api/types/CreateSimulationDto.ts +++ b/src/api/resources/simulations/client/requests/CreateSimulationDto.ts @@ -1,16 +1,23 @@ // This file was auto-generated by Fern from our API Definition. +/** + * @example + * { + * scenarioId: "scenarioId", + * personalityId: "personalityId" + * } + */ export interface CreateSimulationDto { - /** This is an optional friendly name for the simulation. */ - name?: string | undefined; - /** This is the ID of the scenario to use for this simulation. */ + /** Optional display name for the simulation. */ + name?: string; + /** The ID of the scenario to run. */ scenarioId: string; - /** This is the ID of the personality to use for this simulation. */ + /** The ID of the personality the AI tester uses. */ personalityId: string; /** * Optional folder path for organizing simulations. * Supports up to 3 levels (e.g., "dept/feature/variant"). * Maps to GitOps resource folder structure. */ - path?: (string | null) | undefined; + path?: string | null; } diff --git a/src/api/types/GenerateScenariosDto.ts b/src/api/resources/simulations/client/requests/GenerateScenariosDto.ts similarity index 73% rename from src/api/types/GenerateScenariosDto.ts rename to src/api/resources/simulations/client/requests/GenerateScenariosDto.ts index 6108ebee..85e6ba7a 100644 --- a/src/api/types/GenerateScenariosDto.ts +++ b/src/api/resources/simulations/client/requests/GenerateScenariosDto.ts @@ -1,8 +1,12 @@ // This file was auto-generated by Fern from our API Definition. +/** + * @example + * {} + */ export interface GenerateScenariosDto { /** ID of the assistant to generate scenarios for */ - assistantId?: string | undefined; + assistantId?: string; /** ID of the squad to generate scenarios for */ - squadId?: string | undefined; + squadId?: string; } diff --git a/src/api/resources/simulations/client/requests/SimulationControllerFindAllRequest.ts b/src/api/resources/simulations/client/requests/SimulationControllerFindAllRequest.ts new file mode 100644 index 00000000..98fa9b43 --- /dev/null +++ b/src/api/resources/simulations/client/requests/SimulationControllerFindAllRequest.ts @@ -0,0 +1,38 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../../index.js"; + +/** + * @example + * {} + */ +export interface SimulationControllerFindAllRequest { + /** Return only simulations matching the provided ids */ + idAny?: string | string[]; + /** Only include simulations that are not part of a suite */ + standaloneOnly?: boolean; + /** This is the page number to return. Defaults to 1. */ + page?: number; + /** This is the sort order for pagination. Defaults to 'DESC'. */ + sortOrder?: Vapi.SimulationControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.SimulationControllerFindAllRequestSortBy; + /** This is the maximum number of items to return. Defaults to 100. */ + limit?: number; + /** This will return items where the createdAt is greater than the specified value. */ + createdAtGt?: string; + /** This will return items where the createdAt is less than the specified value. */ + createdAtLt?: string; + /** This will return items where the createdAt is greater than or equal to the specified value. */ + createdAtGe?: string; + /** This will return items where the createdAt is less than or equal to the specified value. */ + createdAtLe?: string; + /** This will return items where the updatedAt is greater than the specified value. */ + updatedAtGt?: string; + /** This will return items where the updatedAt is less than the specified value. */ + updatedAtLt?: string; + /** This will return items where the updatedAt is greater than or equal to the specified value. */ + updatedAtGe?: string; + /** This will return items where the updatedAt is less than or equal to the specified value. */ + updatedAtLe?: string; +} diff --git a/src/api/resources/simulations/client/requests/SimulationControllerFindOneRequest.ts b/src/api/resources/simulations/client/requests/SimulationControllerFindOneRequest.ts new file mode 100644 index 00000000..8907fef0 --- /dev/null +++ b/src/api/resources/simulations/client/requests/SimulationControllerFindOneRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationControllerFindOneRequest { + /** The unique identifier of the simulation. */ + id: string; +} diff --git a/src/api/resources/simulations/client/requests/SimulationControllerRemoveRequest.ts b/src/api/resources/simulations/client/requests/SimulationControllerRemoveRequest.ts new file mode 100644 index 00000000..ef122ca1 --- /dev/null +++ b/src/api/resources/simulations/client/requests/SimulationControllerRemoveRequest.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * @example + * { + * id: "id" + * } + */ +export interface SimulationControllerRemoveRequest { + /** The unique identifier of the simulation. */ + id: string; +} diff --git a/src/api/types/UpdateSimulationDto.ts b/src/api/resources/simulations/client/requests/UpdateSimulationDto.ts similarity index 68% rename from src/api/types/UpdateSimulationDto.ts rename to src/api/resources/simulations/client/requests/UpdateSimulationDto.ts index 3a45cb08..99c9fe14 100644 --- a/src/api/types/UpdateSimulationDto.ts +++ b/src/api/resources/simulations/client/requests/UpdateSimulationDto.ts @@ -1,16 +1,24 @@ // This file was auto-generated by Fern from our API Definition. +/** + * @example + * { + * id: "id" + * } + */ export interface UpdateSimulationDto { + /** The unique identifier of the simulation. */ + id: string; /** This is an optional friendly name for the simulation. */ - name?: string | undefined; + name?: string; /** This is the ID of the scenario to use for this simulation. */ - scenarioId?: string | undefined; + scenarioId?: string; /** This is the ID of the personality to use for this simulation. */ - personalityId?: string | undefined; + personalityId?: string; /** * Optional folder path for organizing simulations. * Supports up to 3 levels (e.g., "dept/feature/variant"). * Set to null to remove from folder. */ - path?: (string | null) | undefined; + path?: string | null; } diff --git a/src/api/resources/simulations/client/requests/index.ts b/src/api/resources/simulations/client/requests/index.ts new file mode 100644 index 00000000..0932b9e4 --- /dev/null +++ b/src/api/resources/simulations/client/requests/index.ts @@ -0,0 +1,6 @@ +export type { CreateSimulationDto } from "./CreateSimulationDto.js"; +export type { GenerateScenariosDto } from "./GenerateScenariosDto.js"; +export type { SimulationControllerFindAllRequest } from "./SimulationControllerFindAllRequest.js"; +export type { SimulationControllerFindOneRequest } from "./SimulationControllerFindOneRequest.js"; +export type { SimulationControllerRemoveRequest } from "./SimulationControllerRemoveRequest.js"; +export type { UpdateSimulationDto } from "./UpdateSimulationDto.js"; diff --git a/src/api/resources/simulations/exports.ts b/src/api/resources/simulations/exports.ts new file mode 100644 index 00000000..11815c0b --- /dev/null +++ b/src/api/resources/simulations/exports.ts @@ -0,0 +1,4 @@ +// This file was auto-generated by Fern from our API Definition. + +export { SimulationsClient } from "./client/Client.js"; +export * from "./client/index.js"; diff --git a/src/api/resources/simulations/index.ts b/src/api/resources/simulations/index.ts new file mode 100644 index 00000000..d9adb1af --- /dev/null +++ b/src/api/resources/simulations/index.ts @@ -0,0 +1,2 @@ +export * from "./client/index.js"; +export * from "./types/index.js"; diff --git a/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortBy.ts b/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..e561eb3b --- /dev/null +++ b/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type SimulationControllerFindAllRequestSortBy = + (typeof SimulationControllerFindAllRequestSortBy)[keyof typeof SimulationControllerFindAllRequestSortBy]; diff --git a/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortOrder.ts b/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortOrder.ts new file mode 100644 index 00000000..313ee0ed --- /dev/null +++ b/src/api/resources/simulations/types/SimulationControllerFindAllRequestSortOrder.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationControllerFindAllRequestSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type SimulationControllerFindAllRequestSortOrder = + (typeof SimulationControllerFindAllRequestSortOrder)[keyof typeof SimulationControllerFindAllRequestSortOrder]; diff --git a/src/api/resources/simulations/types/index.ts b/src/api/resources/simulations/types/index.ts new file mode 100644 index 00000000..3c38458b --- /dev/null +++ b/src/api/resources/simulations/types/index.ts @@ -0,0 +1,2 @@ +export * from "./SimulationControllerFindAllRequestSortBy.js"; +export * from "./SimulationControllerFindAllRequestSortOrder.js"; diff --git a/src/api/resources/squads/client/Client.ts b/src/api/resources/squads/client/Client.ts index ebaed121..53994ac0 100644 --- a/src/api/resources/squads/client/Client.ts +++ b/src/api/resources/squads/client/Client.ts @@ -23,6 +23,8 @@ export class SquadsClient { } /** + * Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -41,6 +43,7 @@ export class SquadsClient { requestOptions?: SquadsClient.RequestOptions, ): Promise> { const { + idAny, limit, createdAtGt, createdAtLt, @@ -52,6 +55,7 @@ export class SquadsClient { updatedAtLe, } = request; const _queryParams: Record = { + idAny, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -100,6 +104,8 @@ export class SquadsClient { } /** + * Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + * * @param {Vapi.CreateSquadDto} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -160,6 +166,8 @@ export class SquadsClient { } /** + * Returns the squad identified by its ID. + * * @param {Vapi.GetSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -218,6 +226,8 @@ export class SquadsClient { } /** + * Deletes the squad identified by its ID. + * * @param {Vapi.DeleteSquadsRequest} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -276,6 +286,8 @@ export class SquadsClient { } /** + * Updates the specified fields of the squad identified by its ID. + * * @param {Vapi.UpdateSquadDto} request * @param {SquadsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/squads/client/requests/DeleteSquadsRequest.ts b/src/api/resources/squads/client/requests/DeleteSquadsRequest.ts index 5cd563a5..d359a75d 100644 --- a/src/api/resources/squads/client/requests/DeleteSquadsRequest.ts +++ b/src/api/resources/squads/client/requests/DeleteSquadsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface DeleteSquadsRequest { + /** The unique identifier of the squad. */ id: string; } diff --git a/src/api/resources/squads/client/requests/GetSquadsRequest.ts b/src/api/resources/squads/client/requests/GetSquadsRequest.ts index 2f2b0acf..0c7e6b37 100644 --- a/src/api/resources/squads/client/requests/GetSquadsRequest.ts +++ b/src/api/resources/squads/client/requests/GetSquadsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetSquadsRequest { + /** The unique identifier of the squad. */ id: string; } diff --git a/src/api/resources/squads/client/requests/ListSquadsRequest.ts b/src/api/resources/squads/client/requests/ListSquadsRequest.ts index c28a1ef3..f81871d6 100644 --- a/src/api/resources/squads/client/requests/ListSquadsRequest.ts +++ b/src/api/resources/squads/client/requests/ListSquadsRequest.ts @@ -5,6 +5,8 @@ * {} */ export interface ListSquadsRequest { + /** Return only squads matching the provided ids */ + idAny?: string | string[]; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/squads/client/requests/UpdateSquadDto.ts b/src/api/resources/squads/client/requests/UpdateSquadDto.ts index a32aa589..7880af58 100644 --- a/src/api/resources/squads/client/requests/UpdateSquadDto.ts +++ b/src/api/resources/squads/client/requests/UpdateSquadDto.ts @@ -10,6 +10,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateSquadDto { + /** The unique identifier of the squad. */ id: string; /** This is the name of the squad. */ name?: string; diff --git a/src/api/resources/structuredOutputs/client/Client.ts b/src/api/resources/structuredOutputs/client/Client.ts index 2e0677a2..4e1fb921 100644 --- a/src/api/resources/structuredOutputs/client/Client.ts +++ b/src/api/resources/structuredOutputs/client/Client.ts @@ -23,6 +23,8 @@ export class StructuredOutputsClient { } /** + * Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. + * * @param {Vapi.StructuredOutputControllerFindAllRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -45,6 +47,7 @@ export class StructuredOutputsClient { name, page, sortOrder, + sortBy, limit, createdAtGt, createdAtLt, @@ -60,6 +63,7 @@ export class StructuredOutputsClient { name, page, sortOrder: sortOrder != null ? sortOrder : undefined, + sortBy: sortBy != null ? sortBy : undefined, limit, createdAtGt: createdAtGt != null ? createdAtGt : undefined, createdAtLt: createdAtLt != null ? createdAtLt : undefined, @@ -111,6 +115,8 @@ export class StructuredOutputsClient { } /** + * Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. + * * @param {Vapi.CreateStructuredOutputDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -174,6 +180,8 @@ export class StructuredOutputsClient { } /** + * Returns the structured-output definition identified by its ID. + * * @param {Vapi.StructuredOutputControllerFindOneRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -232,6 +240,8 @@ export class StructuredOutputsClient { } /** + * Deletes the structured-output definition identified by its ID. + * * @param {Vapi.StructuredOutputControllerRemoveRequest} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -290,6 +300,8 @@ export class StructuredOutputsClient { } /** + * Updates the structured-output definition identified by its ID. + * * @param {Vapi.UpdateStructuredOutputDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -355,6 +367,8 @@ export class StructuredOutputsClient { } /** + * Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. + * * @param {Vapi.StructuredOutputRunDto} request * @param {StructuredOutputsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -366,14 +380,14 @@ export class StructuredOutputsClient { public structuredOutputControllerRun( request: Vapi.StructuredOutputRunDto, requestOptions?: StructuredOutputsClient.RequestOptions, - ): core.HttpResponsePromise { + ): core.HttpResponsePromise { return core.HttpResponsePromise.fromPromise(this.__structuredOutputControllerRun(request, requestOptions)); } private async __structuredOutputControllerRun( request: Vapi.StructuredOutputRunDto, requestOptions?: StructuredOutputsClient.RequestOptions, - ): Promise> { + ): Promise> { const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest(); const _headers: core.Fetcher.Args["headers"] = mergeHeaders( _authRequest.headers, @@ -400,7 +414,10 @@ export class StructuredOutputsClient { logging: this._options.logging, }); if (_response.ok) { - return { data: _response.body as Vapi.StructuredOutput, rawResponse: _response.rawResponse }; + return { + data: _response.body as Vapi.StructuredOutputControllerRunResponse, + rawResponse: _response.rawResponse, + }; } if (_response.error.reason === "status-code") { diff --git a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindAllRequest.ts b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindAllRequest.ts index 35b3658f..a1dc6c2b 100644 --- a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindAllRequest.ts +++ b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindAllRequest.ts @@ -15,6 +15,8 @@ export interface StructuredOutputControllerFindAllRequest { page?: number; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.StructuredOutputControllerFindAllRequestSortOrder; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.StructuredOutputControllerFindAllRequestSortBy; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindOneRequest.ts b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindOneRequest.ts index f5d98247..09db5467 100644 --- a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindOneRequest.ts +++ b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerFindOneRequest.ts @@ -7,5 +7,6 @@ * } */ export interface StructuredOutputControllerFindOneRequest { + /** The unique identifier of the structured output. */ id: string; } diff --git a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerRemoveRequest.ts b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerRemoveRequest.ts index 9b6cb614..e3a46d10 100644 --- a/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerRemoveRequest.ts +++ b/src/api/resources/structuredOutputs/client/requests/StructuredOutputControllerRemoveRequest.ts @@ -7,5 +7,6 @@ * } */ export interface StructuredOutputControllerRemoveRequest { + /** The unique identifier of the structured output. */ id: string; } diff --git a/src/api/resources/structuredOutputs/client/requests/UpdateStructuredOutputDto.ts b/src/api/resources/structuredOutputs/client/requests/UpdateStructuredOutputDto.ts index cba76e7e..1b39ca23 100644 --- a/src/api/resources/structuredOutputs/client/requests/UpdateStructuredOutputDto.ts +++ b/src/api/resources/structuredOutputs/client/requests/UpdateStructuredOutputDto.ts @@ -10,7 +10,9 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateStructuredOutputDto { + /** The unique identifier of the structured output. */ id: string; + /** Set to the string `true` to allow changing the schema's top-level type. Other values do not enable schema type changes. */ schemaOverride: string; /** * This is the type of structured output. @@ -50,6 +52,8 @@ export interface UpdateStructuredOutputDto { model?: Vapi.UpdateStructuredOutputDtoModel; /** Compliance configuration for this output. Only enable overrides if no sensitive data will be stored. */ compliancePlan?: Vapi.ComplianceOverride; + /** These are the conditions that gate the execution of this structured output. Every condition must pass for the structured output to run (AND semantics). When omitted or empty, no user-defined conditions gate this output. Send null to clear a previously saved gate. */ + conditions?: Vapi.UpdateStructuredOutputDtoConditionsItem[] | null; /** This is the name of the structured output. */ name?: string; /** diff --git a/src/api/resources/structuredOutputs/types/StructuredOutputControllerFindAllRequestSortBy.ts b/src/api/resources/structuredOutputs/types/StructuredOutputControllerFindAllRequestSortBy.ts new file mode 100644 index 00000000..5cd94d2d --- /dev/null +++ b/src/api/resources/structuredOutputs/types/StructuredOutputControllerFindAllRequestSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export const StructuredOutputControllerFindAllRequestSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type StructuredOutputControllerFindAllRequestSortBy = + (typeof StructuredOutputControllerFindAllRequestSortBy)[keyof typeof StructuredOutputControllerFindAllRequestSortBy]; diff --git a/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponse.ts b/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponse.ts new file mode 100644 index 00000000..1fef9a1e --- /dev/null +++ b/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponse.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export type StructuredOutputControllerRunResponse = + | Vapi.StructuredOutputControllerRunResponseZero + | Vapi.StructuredOutputRerunResponse; diff --git a/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponseZero.ts b/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponseZero.ts new file mode 100644 index 00000000..bf4b716d --- /dev/null +++ b/src/api/resources/structuredOutputs/types/StructuredOutputControllerRunResponseZero.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export interface StructuredOutputControllerRunResponseZero { + /** + * These are the structured outputs whose conditions gated them, keyed by + * structured output id. Absent when nothing was skipped. An entry here means + * no extraction ran and no cost was incurred for that output. + */ + skipped?: Record | undefined; +} diff --git a/src/api/resources/structuredOutputs/types/UpdateStructuredOutputDtoConditionsItem.ts b/src/api/resources/structuredOutputs/types/UpdateStructuredOutputDtoConditionsItem.ts new file mode 100644 index 00000000..73b4efec --- /dev/null +++ b/src/api/resources/structuredOutputs/types/UpdateStructuredOutputDtoConditionsItem.ts @@ -0,0 +1,22 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../../../index.js"; + +export type UpdateStructuredOutputDtoConditionsItem = + | Vapi.UpdateStructuredOutputDtoConditionsItem.MinMessages + | Vapi.UpdateStructuredOutputDtoConditionsItem.MinCallDuration + | Vapi.UpdateStructuredOutputDtoConditionsItem.EndedReason; + +export namespace UpdateStructuredOutputDtoConditionsItem { + export interface MinMessages extends Vapi.MinMessagesCondition { + type: "minMessages"; + } + + export interface MinCallDuration extends Vapi.MinCallDurationCondition { + type: "minCallDuration"; + } + + export interface EndedReason extends Vapi.EndedReasonCondition { + type: "endedReason"; + } +} diff --git a/src/api/resources/structuredOutputs/types/index.ts b/src/api/resources/structuredOutputs/types/index.ts index 88f128ea..4ae8801c 100644 --- a/src/api/resources/structuredOutputs/types/index.ts +++ b/src/api/resources/structuredOutputs/types/index.ts @@ -1,3 +1,7 @@ +export * from "./StructuredOutputControllerFindAllRequestSortBy.js"; export * from "./StructuredOutputControllerFindAllRequestSortOrder.js"; +export * from "./StructuredOutputControllerRunResponse.js"; +export * from "./StructuredOutputControllerRunResponseZero.js"; +export * from "./UpdateStructuredOutputDtoConditionsItem.js"; export * from "./UpdateStructuredOutputDtoModel.js"; export * from "./UpdateStructuredOutputDtoType.js"; diff --git a/src/api/resources/tools/client/Client.ts b/src/api/resources/tools/client/Client.ts index 8c20113a..67398118 100644 --- a/src/api/resources/tools/client/Client.ts +++ b/src/api/resources/tools/client/Client.ts @@ -7,7 +7,7 @@ import * as core from "../../../../core/index.js"; import * as environments from "../../../../environments.js"; import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js"; import * as errors from "../../../../errors/index.js"; -import type * as Vapi from "../../../index.js"; +import * as Vapi from "../../../index.js"; export declare namespace ToolsClient { export type Options = BaseClientOptions; @@ -23,6 +23,8 @@ export class ToolsClient { } /** + * Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param {Vapi.ListToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -100,6 +102,8 @@ export class ToolsClient { } /** + * Creates a reusable tool that assistants can invoke during conversations. + * * @param {Vapi.CreateToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -162,6 +166,8 @@ export class ToolsClient { } /** + * Returns the tool identified by its ID. + * * @param {Vapi.GetToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * @@ -220,9 +226,13 @@ export class ToolsClient { } /** + * Deletes the tool identified by its ID. + * * @param {Vapi.DeleteToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * + * @throws {@link Vapi.ConflictError} + * * @example * await client.tools.delete({ * id: "id" @@ -267,17 +277,24 @@ export class ToolsClient { } if (_response.error.reason === "status-code") { - throw new errors.VapiError({ - statusCode: _response.error.statusCode, - body: _response.error.body, - rawResponse: _response.rawResponse, - }); + switch (_response.error.statusCode) { + case 409: + throw new Vapi.ConflictError(_response.error.body as unknown, _response.rawResponse); + default: + throw new errors.VapiError({ + statusCode: _response.error.statusCode, + body: _response.error.body, + rawResponse: _response.rawResponse, + }); + } } return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/tool/{id}"); } /** + * Updates the specified fields of the tool identified by its ID. + * * @param {Vapi.UpdateToolsRequest} request * @param {ToolsClient.RequestOptions} requestOptions - Request-specific configuration. * diff --git a/src/api/resources/tools/client/requests/DeleteToolsRequest.ts b/src/api/resources/tools/client/requests/DeleteToolsRequest.ts index 5e0c2ff4..ffc6eeb3 100644 --- a/src/api/resources/tools/client/requests/DeleteToolsRequest.ts +++ b/src/api/resources/tools/client/requests/DeleteToolsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface DeleteToolsRequest { + /** The unique identifier of the tool. */ id: string; } diff --git a/src/api/resources/tools/client/requests/GetToolsRequest.ts b/src/api/resources/tools/client/requests/GetToolsRequest.ts index 02a347cd..a8782a74 100644 --- a/src/api/resources/tools/client/requests/GetToolsRequest.ts +++ b/src/api/resources/tools/client/requests/GetToolsRequest.ts @@ -7,5 +7,6 @@ * } */ export interface GetToolsRequest { + /** The unique identifier of the tool. */ id: string; } diff --git a/src/api/resources/tools/client/requests/UpdateToolsRequest.ts b/src/api/resources/tools/client/requests/UpdateToolsRequest.ts index 2d1633ca..a38b0c4c 100644 --- a/src/api/resources/tools/client/requests/UpdateToolsRequest.ts +++ b/src/api/resources/tools/client/requests/UpdateToolsRequest.ts @@ -12,6 +12,7 @@ import type * as Vapi from "../../../../index.js"; * } */ export interface UpdateToolsRequest { + /** The unique identifier of the tool. */ id: string; body: Vapi.UpdateToolsRequestBody; } diff --git a/src/api/resources/tools/types/CreateToolsRequest.ts b/src/api/resources/tools/types/CreateToolsRequest.ts index cd0ad6cb..bccbe360 100644 --- a/src/api/resources/tools/types/CreateToolsRequest.ts +++ b/src/api/resources/tools/types/CreateToolsRequest.ts @@ -114,4 +114,28 @@ export namespace CreateToolsRequest { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.CreateToolsRequest.ApiRequest + | Vapi.CreateToolsRequest.Dtmf + | Vapi.CreateToolsRequest.EndCall + | Vapi.CreateToolsRequest.Function + | Vapi.CreateToolsRequest.TransferCall + | Vapi.CreateToolsRequest.Handoff + | Vapi.CreateToolsRequest.Bash + | Vapi.CreateToolsRequest.Computer + | Vapi.CreateToolsRequest.TextEditor + | Vapi.CreateToolsRequest.Query + | Vapi.CreateToolsRequest.GoogleCalendarEventCreate + | Vapi.CreateToolsRequest.GoogleSheetsRowAppend + | Vapi.CreateToolsRequest.GoogleCalendarAvailabilityCheck + | Vapi.CreateToolsRequest.SlackMessageSend + | Vapi.CreateToolsRequest.Sms + | Vapi.CreateToolsRequest.Mcp + | Vapi.CreateToolsRequest.GohighlevelCalendarAvailabilityCheck + | Vapi.CreateToolsRequest.GohighlevelCalendarEventCreate + | Vapi.CreateToolsRequest.GohighlevelContactCreate + | Vapi.CreateToolsRequest.GohighlevelContactGet + | Vapi.CreateToolsRequest.SipRequest + | Vapi.CreateToolsRequest.Voicemail; } diff --git a/src/api/resources/tools/types/CreateToolsResponse.ts b/src/api/resources/tools/types/CreateToolsResponse.ts index bd48a316..fa91f326 100644 --- a/src/api/resources/tools/types/CreateToolsResponse.ts +++ b/src/api/resources/tools/types/CreateToolsResponse.ts @@ -8,6 +8,7 @@ export type CreateToolsResponse = | Vapi.CreateToolsResponse.Dtmf | Vapi.CreateToolsResponse.EndCall | Vapi.CreateToolsResponse.Function + | Vapi.CreateToolsResponse.KnowledgeBase | Vapi.CreateToolsResponse.TransferCall | Vapi.CreateToolsResponse.Handoff | Vapi.CreateToolsResponse.Bash @@ -48,6 +49,10 @@ export namespace CreateToolsResponse { type: "function"; } + export interface KnowledgeBase extends Vapi.KnowledgeBaseTool { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.TransferCallTool { type: "transferCall"; } @@ -119,4 +124,30 @@ export namespace CreateToolsResponse { export interface Voicemail extends Vapi.VoicemailTool { type: "voicemail"; } + + export type Response = + | Vapi.CreateToolsResponse.ApiRequest + | Vapi.CreateToolsResponse.Code + | Vapi.CreateToolsResponse.Dtmf + | Vapi.CreateToolsResponse.EndCall + | Vapi.CreateToolsResponse.Function + | Vapi.CreateToolsResponse.KnowledgeBase + | Vapi.CreateToolsResponse.TransferCall + | Vapi.CreateToolsResponse.Handoff + | Vapi.CreateToolsResponse.Bash + | Vapi.CreateToolsResponse.Computer + | Vapi.CreateToolsResponse.TextEditor + | Vapi.CreateToolsResponse.Query + | Vapi.CreateToolsResponse.GoogleCalendarEventCreate + | Vapi.CreateToolsResponse.GoogleSheetsRowAppend + | Vapi.CreateToolsResponse.GoogleCalendarAvailabilityCheck + | Vapi.CreateToolsResponse.SlackMessageSend + | Vapi.CreateToolsResponse.Sms + | Vapi.CreateToolsResponse.Mcp + | Vapi.CreateToolsResponse.GohighlevelCalendarAvailabilityCheck + | Vapi.CreateToolsResponse.GohighlevelCalendarEventCreate + | Vapi.CreateToolsResponse.GohighlevelContactCreate + | Vapi.CreateToolsResponse.GohighlevelContactGet + | Vapi.CreateToolsResponse.SipRequest + | Vapi.CreateToolsResponse.Voicemail; } diff --git a/src/api/resources/tools/types/DeleteToolsResponse.ts b/src/api/resources/tools/types/DeleteToolsResponse.ts index f403a865..76c4db0a 100644 --- a/src/api/resources/tools/types/DeleteToolsResponse.ts +++ b/src/api/resources/tools/types/DeleteToolsResponse.ts @@ -8,6 +8,7 @@ export type DeleteToolsResponse = | Vapi.DeleteToolsResponse.Dtmf | Vapi.DeleteToolsResponse.EndCall | Vapi.DeleteToolsResponse.Function + | Vapi.DeleteToolsResponse.KnowledgeBase | Vapi.DeleteToolsResponse.TransferCall | Vapi.DeleteToolsResponse.Handoff | Vapi.DeleteToolsResponse.Bash @@ -48,6 +49,10 @@ export namespace DeleteToolsResponse { type: "function"; } + export interface KnowledgeBase extends Vapi.KnowledgeBaseTool { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.TransferCallTool { type: "transferCall"; } @@ -119,4 +124,30 @@ export namespace DeleteToolsResponse { export interface Voicemail extends Vapi.VoicemailTool { type: "voicemail"; } + + export type Response = + | Vapi.DeleteToolsResponse.ApiRequest + | Vapi.DeleteToolsResponse.Code + | Vapi.DeleteToolsResponse.Dtmf + | Vapi.DeleteToolsResponse.EndCall + | Vapi.DeleteToolsResponse.Function + | Vapi.DeleteToolsResponse.KnowledgeBase + | Vapi.DeleteToolsResponse.TransferCall + | Vapi.DeleteToolsResponse.Handoff + | Vapi.DeleteToolsResponse.Bash + | Vapi.DeleteToolsResponse.Computer + | Vapi.DeleteToolsResponse.TextEditor + | Vapi.DeleteToolsResponse.Query + | Vapi.DeleteToolsResponse.GoogleCalendarEventCreate + | Vapi.DeleteToolsResponse.GoogleSheetsRowAppend + | Vapi.DeleteToolsResponse.GoogleCalendarAvailabilityCheck + | Vapi.DeleteToolsResponse.SlackMessageSend + | Vapi.DeleteToolsResponse.Sms + | Vapi.DeleteToolsResponse.Mcp + | Vapi.DeleteToolsResponse.GohighlevelCalendarAvailabilityCheck + | Vapi.DeleteToolsResponse.GohighlevelCalendarEventCreate + | Vapi.DeleteToolsResponse.GohighlevelContactCreate + | Vapi.DeleteToolsResponse.GohighlevelContactGet + | Vapi.DeleteToolsResponse.SipRequest + | Vapi.DeleteToolsResponse.Voicemail; } diff --git a/src/api/resources/tools/types/GetToolsResponse.ts b/src/api/resources/tools/types/GetToolsResponse.ts index 4c1300d0..2520e6cf 100644 --- a/src/api/resources/tools/types/GetToolsResponse.ts +++ b/src/api/resources/tools/types/GetToolsResponse.ts @@ -8,6 +8,7 @@ export type GetToolsResponse = | Vapi.GetToolsResponse.Dtmf | Vapi.GetToolsResponse.EndCall | Vapi.GetToolsResponse.Function + | Vapi.GetToolsResponse.KnowledgeBase | Vapi.GetToolsResponse.TransferCall | Vapi.GetToolsResponse.Handoff | Vapi.GetToolsResponse.Bash @@ -48,6 +49,10 @@ export namespace GetToolsResponse { type: "function"; } + export interface KnowledgeBase extends Vapi.KnowledgeBaseTool { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.TransferCallTool { type: "transferCall"; } @@ -119,4 +124,30 @@ export namespace GetToolsResponse { export interface Voicemail extends Vapi.VoicemailTool { type: "voicemail"; } + + export type Response = + | Vapi.GetToolsResponse.ApiRequest + | Vapi.GetToolsResponse.Code + | Vapi.GetToolsResponse.Dtmf + | Vapi.GetToolsResponse.EndCall + | Vapi.GetToolsResponse.Function + | Vapi.GetToolsResponse.KnowledgeBase + | Vapi.GetToolsResponse.TransferCall + | Vapi.GetToolsResponse.Handoff + | Vapi.GetToolsResponse.Bash + | Vapi.GetToolsResponse.Computer + | Vapi.GetToolsResponse.TextEditor + | Vapi.GetToolsResponse.Query + | Vapi.GetToolsResponse.GoogleCalendarEventCreate + | Vapi.GetToolsResponse.GoogleSheetsRowAppend + | Vapi.GetToolsResponse.GoogleCalendarAvailabilityCheck + | Vapi.GetToolsResponse.SlackMessageSend + | Vapi.GetToolsResponse.Sms + | Vapi.GetToolsResponse.Mcp + | Vapi.GetToolsResponse.GohighlevelCalendarAvailabilityCheck + | Vapi.GetToolsResponse.GohighlevelCalendarEventCreate + | Vapi.GetToolsResponse.GohighlevelContactCreate + | Vapi.GetToolsResponse.GohighlevelContactGet + | Vapi.GetToolsResponse.SipRequest + | Vapi.GetToolsResponse.Voicemail; } diff --git a/src/api/resources/tools/types/ListToolsResponseItem.ts b/src/api/resources/tools/types/ListToolsResponseItem.ts index 2ee2c8b3..2278cb28 100644 --- a/src/api/resources/tools/types/ListToolsResponseItem.ts +++ b/src/api/resources/tools/types/ListToolsResponseItem.ts @@ -8,6 +8,7 @@ export type ListToolsResponseItem = | Vapi.ListToolsResponseItem.Dtmf | Vapi.ListToolsResponseItem.EndCall | Vapi.ListToolsResponseItem.Function + | Vapi.ListToolsResponseItem.KnowledgeBase | Vapi.ListToolsResponseItem.TransferCall | Vapi.ListToolsResponseItem.Handoff | Vapi.ListToolsResponseItem.Bash @@ -48,6 +49,10 @@ export namespace ListToolsResponseItem { type: "function"; } + export interface KnowledgeBase extends Vapi.KnowledgeBaseTool { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.TransferCallTool { type: "transferCall"; } @@ -119,4 +124,30 @@ export namespace ListToolsResponseItem { export interface Voicemail extends Vapi.VoicemailTool { type: "voicemail"; } + + export type Response = + | Vapi.ListToolsResponseItem.ApiRequest + | Vapi.ListToolsResponseItem.Code + | Vapi.ListToolsResponseItem.Dtmf + | Vapi.ListToolsResponseItem.EndCall + | Vapi.ListToolsResponseItem.Function + | Vapi.ListToolsResponseItem.KnowledgeBase + | Vapi.ListToolsResponseItem.TransferCall + | Vapi.ListToolsResponseItem.Handoff + | Vapi.ListToolsResponseItem.Bash + | Vapi.ListToolsResponseItem.Computer + | Vapi.ListToolsResponseItem.TextEditor + | Vapi.ListToolsResponseItem.Query + | Vapi.ListToolsResponseItem.GoogleCalendarEventCreate + | Vapi.ListToolsResponseItem.GoogleSheetsRowAppend + | Vapi.ListToolsResponseItem.GoogleCalendarAvailabilityCheck + | Vapi.ListToolsResponseItem.SlackMessageSend + | Vapi.ListToolsResponseItem.Sms + | Vapi.ListToolsResponseItem.Mcp + | Vapi.ListToolsResponseItem.GohighlevelCalendarAvailabilityCheck + | Vapi.ListToolsResponseItem.GohighlevelCalendarEventCreate + | Vapi.ListToolsResponseItem.GohighlevelContactCreate + | Vapi.ListToolsResponseItem.GohighlevelContactGet + | Vapi.ListToolsResponseItem.SipRequest + | Vapi.ListToolsResponseItem.Voicemail; } diff --git a/src/api/resources/tools/types/UpdateToolsRequestBody.ts b/src/api/resources/tools/types/UpdateToolsRequestBody.ts index 909693a1..facf7f26 100644 --- a/src/api/resources/tools/types/UpdateToolsRequestBody.ts +++ b/src/api/resources/tools/types/UpdateToolsRequestBody.ts @@ -7,6 +7,7 @@ export type UpdateToolsRequestBody = | Vapi.UpdateToolsRequestBody.Dtmf | Vapi.UpdateToolsRequestBody.EndCall | Vapi.UpdateToolsRequestBody.Function + | Vapi.UpdateToolsRequestBody.KnowledgeBase | Vapi.UpdateToolsRequestBody.TransferCall | Vapi.UpdateToolsRequestBody.Handoff | Vapi.UpdateToolsRequestBody.Bash @@ -43,6 +44,10 @@ export namespace UpdateToolsRequestBody { type: "function"; } + export interface KnowledgeBase extends Vapi.UpdateKnowledgeBaseToolDto { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.UpdateTransferCallToolDto { type: "transferCall"; } @@ -114,4 +119,29 @@ export namespace UpdateToolsRequestBody { export interface Voicemail extends Vapi.UpdateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.UpdateToolsRequestBody.ApiRequest + | Vapi.UpdateToolsRequestBody.Dtmf + | Vapi.UpdateToolsRequestBody.EndCall + | Vapi.UpdateToolsRequestBody.Function + | Vapi.UpdateToolsRequestBody.KnowledgeBase + | Vapi.UpdateToolsRequestBody.TransferCall + | Vapi.UpdateToolsRequestBody.Handoff + | Vapi.UpdateToolsRequestBody.Bash + | Vapi.UpdateToolsRequestBody.Computer + | Vapi.UpdateToolsRequestBody.TextEditor + | Vapi.UpdateToolsRequestBody.Query + | Vapi.UpdateToolsRequestBody.GoogleCalendarEventCreate + | Vapi.UpdateToolsRequestBody.GoogleSheetsRowAppend + | Vapi.UpdateToolsRequestBody.GoogleCalendarAvailabilityCheck + | Vapi.UpdateToolsRequestBody.SlackMessageSend + | Vapi.UpdateToolsRequestBody.Sms + | Vapi.UpdateToolsRequestBody.Mcp + | Vapi.UpdateToolsRequestBody.GohighlevelCalendarAvailabilityCheck + | Vapi.UpdateToolsRequestBody.GohighlevelCalendarEventCreate + | Vapi.UpdateToolsRequestBody.GohighlevelContactCreate + | Vapi.UpdateToolsRequestBody.GohighlevelContactGet + | Vapi.UpdateToolsRequestBody.SipRequest + | Vapi.UpdateToolsRequestBody.Voicemail; } diff --git a/src/api/resources/tools/types/UpdateToolsResponse.ts b/src/api/resources/tools/types/UpdateToolsResponse.ts index 709e187d..7f94a98b 100644 --- a/src/api/resources/tools/types/UpdateToolsResponse.ts +++ b/src/api/resources/tools/types/UpdateToolsResponse.ts @@ -8,6 +8,7 @@ export type UpdateToolsResponse = | Vapi.UpdateToolsResponse.Dtmf | Vapi.UpdateToolsResponse.EndCall | Vapi.UpdateToolsResponse.Function + | Vapi.UpdateToolsResponse.KnowledgeBase | Vapi.UpdateToolsResponse.TransferCall | Vapi.UpdateToolsResponse.Handoff | Vapi.UpdateToolsResponse.Bash @@ -48,6 +49,10 @@ export namespace UpdateToolsResponse { type: "function"; } + export interface KnowledgeBase extends Vapi.KnowledgeBaseTool { + type: "knowledgeBase"; + } + export interface TransferCall extends Vapi.TransferCallTool { type: "transferCall"; } @@ -119,4 +124,30 @@ export namespace UpdateToolsResponse { export interface Voicemail extends Vapi.VoicemailTool { type: "voicemail"; } + + export type Response = + | Vapi.UpdateToolsResponse.ApiRequest + | Vapi.UpdateToolsResponse.Code + | Vapi.UpdateToolsResponse.Dtmf + | Vapi.UpdateToolsResponse.EndCall + | Vapi.UpdateToolsResponse.Function + | Vapi.UpdateToolsResponse.KnowledgeBase + | Vapi.UpdateToolsResponse.TransferCall + | Vapi.UpdateToolsResponse.Handoff + | Vapi.UpdateToolsResponse.Bash + | Vapi.UpdateToolsResponse.Computer + | Vapi.UpdateToolsResponse.TextEditor + | Vapi.UpdateToolsResponse.Query + | Vapi.UpdateToolsResponse.GoogleCalendarEventCreate + | Vapi.UpdateToolsResponse.GoogleSheetsRowAppend + | Vapi.UpdateToolsResponse.GoogleCalendarAvailabilityCheck + | Vapi.UpdateToolsResponse.SlackMessageSend + | Vapi.UpdateToolsResponse.Sms + | Vapi.UpdateToolsResponse.Mcp + | Vapi.UpdateToolsResponse.GohighlevelCalendarAvailabilityCheck + | Vapi.UpdateToolsResponse.GohighlevelCalendarEventCreate + | Vapi.UpdateToolsResponse.GohighlevelContactCreate + | Vapi.UpdateToolsResponse.GohighlevelContactGet + | Vapi.UpdateToolsResponse.SipRequest + | Vapi.UpdateToolsResponse.Voicemail; } diff --git a/src/api/types/AiEdgeCondition.ts b/src/api/types/AiEdgeCondition.ts index 94a584f4..cf03796b 100644 --- a/src/api/types/AiEdgeCondition.ts +++ b/src/api/types/AiEdgeCondition.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * An AI-evaluated boolean condition that determines whether a workflow follows an edge. + */ export interface AiEdgeCondition { + /** Selects an AI-evaluated workflow edge condition. */ type: Vapi.AiEdgeConditionType; /** This is the prompt for the AI edge condition. It should evaluate to a boolean. */ prompt: string; diff --git a/src/api/types/AiEdgeConditionType.ts b/src/api/types/AiEdgeConditionType.ts index 1500e779..55ebb4c5 100644 --- a/src/api/types/AiEdgeConditionType.ts +++ b/src/api/types/AiEdgeConditionType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects an AI-evaluated workflow edge condition. */ export const AiEdgeConditionType = { Ai: "ai", } as const; diff --git a/src/api/types/Analysis.ts b/src/api/types/Analysis.ts index 787c6efb..aa34c0b0 100644 --- a/src/api/types/Analysis.ts +++ b/src/api/types/Analysis.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Post-call analysis results, including summary, structured data, and success evaluation outputs. + */ export interface Analysis { /** This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`. */ summary?: string | undefined; diff --git a/src/api/types/AnalysisCost.ts b/src/api/types/AnalysisCost.ts index 5bff038d..b0a31ec1 100644 --- a/src/api/types/AnalysisCost.ts +++ b/src/api/types/AnalysisCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Cost for an individual analysis request, including analysis type, model, token usage, and amount. + */ export interface AnalysisCost { /** This is the type of analysis performed. */ analysisType: Vapi.AnalysisCostAnalysisType; @@ -13,6 +16,14 @@ export interface AnalysisCost { completionTokens: number; /** This is the number of cached prompt tokens used in the analysis. This is only applicable to certain providers (e.g., OpenAI, Azure OpenAI) that support prompt caching. Cached tokens are billed at a discounted rate. */ cachedPromptTokens?: number | undefined; + /** + * This is the per-structured-output breakdown of this cost. The `cost`, `promptTokens`, `completionTokens` and `cachedPromptTokens` above are the sums of these rows. + * + * This is only set when `analysisType` is `structuredOutput`, and it is omitted entirely rather than partially populated, so when it is present the rows always reconcile to the totals above. + * + * A structured output that was skipped, or that extracts via regex, makes no LLM call and so has no row here — this is not a complete list of the call's configured structured outputs. There is one row per evaluation, so a `structuredOutputId` can appear more than once if it was evaluated more than once; sum the rows rather than indexing them by id. + */ + structuredOutputBreakdown?: Vapi.StructuredOutputCostBreakdown[] | undefined; /** This is the cost of the component in USD. */ cost: number; } diff --git a/src/api/types/AnalysisCostBreakdown.ts b/src/api/types/AnalysisCostBreakdown.ts index 1b219acd..b51a0d54 100644 --- a/src/api/types/AnalysisCostBreakdown.ts +++ b/src/api/types/AnalysisCostBreakdown.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output generation. + */ export interface AnalysisCostBreakdown { /** This is the cost to summarize the call. */ summary?: number | undefined; diff --git a/src/api/types/AnalysisPlan.ts b/src/api/types/AnalysisPlan.ts index 816c2384..ebed9015 100644 --- a/src/api/types/AnalysisPlan.ts +++ b/src/api/types/AnalysisPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes. + */ export interface AnalysisPlan { /** * The minimum number of messages required to run the analysis plan. diff --git a/src/api/types/AnalyticsOperation.ts b/src/api/types/AnalyticsOperation.ts index 2dd530d4..667cd9eb 100644 --- a/src/api/types/AnalyticsOperation.ts +++ b/src/api/types/AnalyticsOperation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An aggregation or history operation applied to an analytics column, with an optional response alias. + */ export interface AnalyticsOperation { /** This is the aggregation operation you want to perform. */ operation: Vapi.AnalyticsOperationOperation; diff --git a/src/api/types/AnalyticsQuery.ts b/src/api/types/AnalyticsQuery.ts index 200a48ea..3671b300 100644 --- a/src/api/types/AnalyticsQuery.ts +++ b/src/api/types/AnalyticsQuery.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A named analytics query against call or subscription data, including grouping, time range, and aggregation operations. + */ export interface AnalyticsQuery { /** This is the table you want to query. */ table: Vapi.AnalyticsQueryTable; diff --git a/src/api/types/AnalyticsQueryResult.ts b/src/api/types/AnalyticsQueryResult.ts index 8889fb3a..8e0163d2 100644 --- a/src/api/types/AnalyticsQueryResult.ts +++ b/src/api/types/AnalyticsQueryResult.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The result of a named analytics query, including the evaluated time range and returned metric data. + */ export interface AnalyticsQueryResult { /** This is the unique key for the query. */ name: string; diff --git a/src/api/types/AnthropicBedrockCredentialRegion.ts b/src/api/types/AnthropicBedrockCredentialRegion.ts index 22be2345..595e3f23 100644 --- a/src/api/types/AnthropicBedrockCredentialRegion.ts +++ b/src/api/types/AnthropicBedrockCredentialRegion.ts @@ -4,6 +4,7 @@ export const AnthropicBedrockCredentialRegion = { UsEast1: "us-east-1", UsWest2: "us-west-2", + EuCentral1: "eu-central-1", EuWest1: "eu-west-1", EuWest3: "eu-west-3", ApNortheast1: "ap-northeast-1", diff --git a/src/api/types/AnthropicBedrockModel.ts b/src/api/types/AnthropicBedrockModel.ts index 4e6c2d03..c9a984f7 100644 --- a/src/api/types/AnthropicBedrockModel.ts +++ b/src/api/types/AnthropicBedrockModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ export interface AnthropicBedrockModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,6 +20,13 @@ export interface AnthropicBedrockModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** The specific Anthropic/Claude model that will be used via Bedrock. */ @@ -27,7 +37,7 @@ export interface AnthropicBedrockModel { * If provided, maxTokens must be greater than thinking.budgetTokens. */ thinking?: Vapi.AnthropicThinkingConfig | undefined; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/AnthropicBedrockModelModel.ts b/src/api/types/AnthropicBedrockModelModel.ts index d2ef7375..c3eaef66 100644 --- a/src/api/types/AnthropicBedrockModelModel.ts +++ b/src/api/types/AnthropicBedrockModelModel.ts @@ -16,5 +16,6 @@ export const AnthropicBedrockModelModel = { ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929", ClaudeSonnet46: "claude-sonnet-4-6", ClaudeHaiku4520251001: "claude-haiku-4-5-20251001", + GlobalAnthropicClaudeHaiku4520251001V10: "global.anthropic.claude-haiku-4-5-20251001-v1:0", } as const; export type AnthropicBedrockModelModel = (typeof AnthropicBedrockModelModel)[keyof typeof AnthropicBedrockModelModel]; diff --git a/src/api/types/AnthropicBedrockModelToolsItem.ts b/src/api/types/AnthropicBedrockModelToolsItem.ts index f4e47353..602cc2cc 100644 --- a/src/api/types/AnthropicBedrockModelToolsItem.ts +++ b/src/api/types/AnthropicBedrockModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace AnthropicBedrockModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.AnthropicBedrockModelToolsItem.ApiRequest + | Vapi.AnthropicBedrockModelToolsItem.Bash + | Vapi.AnthropicBedrockModelToolsItem.Code + | Vapi.AnthropicBedrockModelToolsItem.Computer + | Vapi.AnthropicBedrockModelToolsItem.Dtmf + | Vapi.AnthropicBedrockModelToolsItem.EndCall + | Vapi.AnthropicBedrockModelToolsItem.Function + | Vapi.AnthropicBedrockModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.AnthropicBedrockModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.AnthropicBedrockModelToolsItem.GohighlevelContactCreate + | Vapi.AnthropicBedrockModelToolsItem.GohighlevelContactGet + | Vapi.AnthropicBedrockModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.AnthropicBedrockModelToolsItem.GoogleCalendarEventCreate + | Vapi.AnthropicBedrockModelToolsItem.GoogleSheetsRowAppend + | Vapi.AnthropicBedrockModelToolsItem.Handoff + | Vapi.AnthropicBedrockModelToolsItem.Mcp + | Vapi.AnthropicBedrockModelToolsItem.Query + | Vapi.AnthropicBedrockModelToolsItem.SlackMessageSend + | Vapi.AnthropicBedrockModelToolsItem.Sms + | Vapi.AnthropicBedrockModelToolsItem.TextEditor + | Vapi.AnthropicBedrockModelToolsItem.TransferCall + | Vapi.AnthropicBedrockModelToolsItem.SipRequest + | Vapi.AnthropicBedrockModelToolsItem.Voicemail; } diff --git a/src/api/types/AnthropicModel.ts b/src/api/types/AnthropicModel.ts index acc371a8..c4ebc3c0 100644 --- a/src/api/types/AnthropicModel.ts +++ b/src/api/types/AnthropicModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ export interface AnthropicModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,6 +20,13 @@ export interface AnthropicModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** The specific Anthropic/Claude model that will be used. */ @@ -27,7 +37,7 @@ export interface AnthropicModel { * If provided, maxTokens must be greater than thinking.budgetTokens. */ thinking?: Vapi.AnthropicThinkingConfig | undefined; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/AnthropicModelModel.ts b/src/api/types/AnthropicModelModel.ts index a932e338..2830cba8 100644 --- a/src/api/types/AnthropicModelModel.ts +++ b/src/api/types/AnthropicModelModel.ts @@ -15,6 +15,7 @@ export const AnthropicModelModel = { ClaudeSonnet420250514: "claude-sonnet-4-20250514", ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929", ClaudeSonnet46: "claude-sonnet-4-6", + ClaudeSonnet5: "claude-sonnet-5", ClaudeHaiku4520251001: "claude-haiku-4-5-20251001", } as const; export type AnthropicModelModel = (typeof AnthropicModelModel)[keyof typeof AnthropicModelModel]; diff --git a/src/api/types/AnthropicModelToolsItem.ts b/src/api/types/AnthropicModelToolsItem.ts index 1cb8c36f..c7e11866 100644 --- a/src/api/types/AnthropicModelToolsItem.ts +++ b/src/api/types/AnthropicModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace AnthropicModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.AnthropicModelToolsItem.ApiRequest + | Vapi.AnthropicModelToolsItem.Bash + | Vapi.AnthropicModelToolsItem.Code + | Vapi.AnthropicModelToolsItem.Computer + | Vapi.AnthropicModelToolsItem.Dtmf + | Vapi.AnthropicModelToolsItem.EndCall + | Vapi.AnthropicModelToolsItem.Function + | Vapi.AnthropicModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.AnthropicModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.AnthropicModelToolsItem.GohighlevelContactCreate + | Vapi.AnthropicModelToolsItem.GohighlevelContactGet + | Vapi.AnthropicModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.AnthropicModelToolsItem.GoogleCalendarEventCreate + | Vapi.AnthropicModelToolsItem.GoogleSheetsRowAppend + | Vapi.AnthropicModelToolsItem.Handoff + | Vapi.AnthropicModelToolsItem.Mcp + | Vapi.AnthropicModelToolsItem.Query + | Vapi.AnthropicModelToolsItem.SlackMessageSend + | Vapi.AnthropicModelToolsItem.Sms + | Vapi.AnthropicModelToolsItem.TextEditor + | Vapi.AnthropicModelToolsItem.TransferCall + | Vapi.AnthropicModelToolsItem.SipRequest + | Vapi.AnthropicModelToolsItem.Voicemail; } diff --git a/src/api/types/AnthropicThinkingConfig.ts b/src/api/types/AnthropicThinkingConfig.ts index d8bebfad..58d7fc7d 100644 --- a/src/api/types/AnthropicThinkingConfig.ts +++ b/src/api/types/AnthropicThinkingConfig.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Enables Anthropic extended thinking with a maximum thinking-token budget. + */ export interface AnthropicThinkingConfig { + /** Enables Anthropic extended thinking. */ type: Vapi.AnthropicThinkingConfigType; /** * The maximum number of tokens to allocate for thinking. diff --git a/src/api/types/AnthropicThinkingConfigType.ts b/src/api/types/AnthropicThinkingConfigType.ts index 99b612f7..9c3ca10b 100644 --- a/src/api/types/AnthropicThinkingConfigType.ts +++ b/src/api/types/AnthropicThinkingConfigType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Enables Anthropic extended thinking. */ export const AnthropicThinkingConfigType = { Enabled: "enabled", } as const; diff --git a/src/api/types/AnyscaleModel.ts b/src/api/types/AnyscaleModel.ts index e681087f..db7dd7bc 100644 --- a/src/api/types/AnyscaleModel.ts +++ b/src/api/types/AnyscaleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface AnyscaleModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface AnyscaleModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/AnyscaleModelToolsItem.ts b/src/api/types/AnyscaleModelToolsItem.ts index b646c187..8cf0c90b 100644 --- a/src/api/types/AnyscaleModelToolsItem.ts +++ b/src/api/types/AnyscaleModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace AnyscaleModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.AnyscaleModelToolsItem.ApiRequest + | Vapi.AnyscaleModelToolsItem.Bash + | Vapi.AnyscaleModelToolsItem.Code + | Vapi.AnyscaleModelToolsItem.Computer + | Vapi.AnyscaleModelToolsItem.Dtmf + | Vapi.AnyscaleModelToolsItem.EndCall + | Vapi.AnyscaleModelToolsItem.Function + | Vapi.AnyscaleModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.AnyscaleModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.AnyscaleModelToolsItem.GohighlevelContactCreate + | Vapi.AnyscaleModelToolsItem.GohighlevelContactGet + | Vapi.AnyscaleModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.AnyscaleModelToolsItem.GoogleCalendarEventCreate + | Vapi.AnyscaleModelToolsItem.GoogleSheetsRowAppend + | Vapi.AnyscaleModelToolsItem.Handoff + | Vapi.AnyscaleModelToolsItem.Mcp + | Vapi.AnyscaleModelToolsItem.Query + | Vapi.AnyscaleModelToolsItem.SlackMessageSend + | Vapi.AnyscaleModelToolsItem.Sms + | Vapi.AnyscaleModelToolsItem.TextEditor + | Vapi.AnyscaleModelToolsItem.TransferCall + | Vapi.AnyscaleModelToolsItem.SipRequest + | Vapi.AnyscaleModelToolsItem.Voicemail; } diff --git a/src/api/types/ApiRequestTool.ts b/src/api/types/ApiRequestTool.ts index 1c8c03a8..895f76d5 100644 --- a/src/api/types/ApiRequestTool.ts +++ b/src/api/types/ApiRequestTool.ts @@ -2,13 +2,20 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ export interface ApiRequestTool { + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.ApiRequestToolMessagesItem[] | undefined; /** - * These are the messages that will be spoken to the user as the tool is running. + * This is the name of the tool. This will be passed to the model. * - * 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. + * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40. */ - messages?: Vapi.ApiRequestToolMessagesItem[] | undefined; + name?: string | undefined; + /** The HTTP method used for the API request. */ method: Vapi.ApiRequestToolMethod; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. @@ -111,12 +118,6 @@ export interface ApiRequestTool { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; - /** - * 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. - */ - name?: string | undefined; /** This is the description of the tool. This will be passed to the model. */ description?: string | undefined; /** This is where the request will be sent. */ diff --git a/src/api/types/ApiRequestToolMethod.ts b/src/api/types/ApiRequestToolMethod.ts index 6538f40b..e36cc4e5 100644 --- a/src/api/types/ApiRequestToolMethod.ts +++ b/src/api/types/ApiRequestToolMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const ApiRequestToolMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/Artifact.ts b/src/api/types/Artifact.ts index 18cd24f6..cdf0b925 100644 --- a/src/api/types/Artifact.ts +++ b/src/api/types/Artifact.ts @@ -2,11 +2,21 @@ import type * as Vapi from "../index.js"; +/** + * Artifacts generated during a call, including messages, recordings, transcript, logs, packet capture, workflow-node data, variables, performance metrics, structured outputs, scorecards, and transfers. + */ export interface Artifact { /** These are the messages that were spoken during the call. */ messages?: Vapi.ArtifactMessagesItem[] | undefined; /** These are the messages that were spoken during the call, formatted for OpenAI. */ messagesOpenAIFormatted?: Vapi.OpenAiMessage[] | undefined; + /** Structured outputs skipped because their conditions were not met, keyed by saved or runtime output ID. */ + skippedStructuredOutputs?: Record | undefined; + /** + * These are the transfer records for the call's transfer attempts (warm and blind), including + * destination, mode, and status. Warm transfer records also include transcripts and messages. + */ + transfers?: Vapi.TransferArtifact[] | undefined; /** This is the recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ recordingUrl?: string | undefined; /** This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ @@ -41,8 +51,52 @@ export interface Artifact { * To enable, set `assistant.artifactPlan.scorecardIds` or `assistant.artifactPlan.scorecards` with the IDs or objects of the scorecards you want to evaluate. */ scorecards?: Record | undefined; - /** These are the transfer records from warm transfers, including destinations, transcripts, and status. */ - transfers?: string[] | undefined; /** This is when the structured outputs were last updated */ structuredOutputsLastUpdatedAt?: string | undefined; + /** + * This is a presigned URL to download the mono recording without + * authentication. Populated on API responses and server messages; never + * stored. Expires at `presignedUrlsExpiresAt` — after that, use + * `GET /call/{id}/mono-recording`. + */ + presignedMonoUrl?: string | undefined; + /** + * This is a presigned URL to download the stereo recording without + * authentication. Expires at `presignedUrlsExpiresAt` — after that, use + * `GET /call/{id}/stereo-recording`. + */ + presignedStereoUrl?: string | undefined; + /** + * This is a presigned URL to download the video recording without + * authentication. Expires at `presignedUrlsExpiresAt` — after that, use + * `GET /call/{id}/video-recording`. + */ + presignedVideoUrl?: string | undefined; + /** + * This is a presigned URL to download the assistant-channel mono recording + * without authentication. Expires at `presignedUrlsExpiresAt`. + */ + presignedAssistantUrl?: string | undefined; + /** + * This is a presigned URL to download the customer-channel mono recording + * without authentication. Expires at `presignedUrlsExpiresAt`. + */ + presignedCustomerUrl?: string | undefined; + /** + * This is a presigned URL to download the packet capture without + * authentication. Expires at `presignedUrlsExpiresAt`. + */ + presignedPcapUrl?: string | undefined; + /** + * This is a presigned URL to download the call logs without + * authentication. Expires at `presignedUrlsExpiresAt`. + */ + presignedLogUrl?: string | undefined; + /** + * This is when the presigned URLs above expire, as an ISO 8601 timestamp. + * The raw `*Url` fields remain the stable identifiers and do not expire. + * Presigned URLs are regenerated per response and per webhook delivery, so + * values differ across retries. + */ + presignedUrlsExpiresAt?: string | undefined; } diff --git a/src/api/types/ArtifactPlan.ts b/src/api/types/ArtifactPlan.ts index bec58829..8fb4ba47 100644 --- a/src/api/types/ArtifactPlan.ts +++ b/src/api/types/ArtifactPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, structured outputs, scorecards, and custom storage paths. + */ export interface ArtifactPlan { /** * This determines whether assistant's calls are recorded. Defaults to true. @@ -30,6 +33,8 @@ export interface ArtifactPlan { * - Set to false if you have custom storage configured but want to store recordings on Vapi's storage for this assistant. * - Set to true (or leave unset) to use your custom storage for recordings when available. * + * If your organization has ZDR (zero data retention) or PCI enabled, recordings are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. + * * @default true */ recordingUseCustomStorageEnabled?: boolean | undefined; @@ -72,6 +77,8 @@ export interface ArtifactPlan { * - Set to false if you have custom storage configured but want to store packet captures on Vapi's storage for this assistant. * - Set to true (or leave unset) to use your custom storage for packet captures when available. * + * If your organization has ZDR (zero data retention) or PCI enabled, packet captures are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. + * * @default true */ pcapUseCustomStorageEnabled?: boolean | undefined; @@ -90,6 +97,8 @@ export interface ArtifactPlan { * - Set to false if you have custom storage configured but want to store logs on Vapi's storage for this assistant. * - Set to true (or leave unset) to use your custom storage for logs when available. * + * If your organization has ZDR (zero data retention) or PCI enabled, logs are never written to Vapi storage. In that case, false means "do not use my custom storage", so nothing is stored at all. + * * @default true */ loggingUseCustomStorageEnabled?: boolean | undefined; diff --git a/src/api/types/AssemblyAiTranscriber.ts b/src/api/types/AssemblyAiTranscriber.ts index 4447dfbb..350f4b5e 100644 --- a/src/api/types/AssemblyAiTranscriber.ts +++ b/src/api/types/AssemblyAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, streaming model, endpointing, vocabulary, and fallback settings. + */ export interface AssemblyAiTranscriber { /** This is the language that will be set for the transcription. */ language?: Vapi.AssemblyAiTranscriberLanguage | undefined; @@ -47,9 +50,22 @@ export interface AssemblyAiTranscriber { * @default true */ vadAssistedEndpointingEnabled?: boolean | undefined; + /** + * This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model. + * + * @default 'balanced' + */ + mode?: Vapi.AssemblyAiTranscriberMode | undefined; + /** This is a prompt that provides additional context to the transcription model. Only applies to the `universal-3-5-pro` speech model. */ + prompt?: string | undefined; + /** This is context about the voice agent that guides the transcription model. Only applies to the `universal-3-5-pro` speech model. */ + agentContext?: string | undefined; + /** These are language codes used to steer automatic language detection. Only applies to the `universal-3-5-pro` speech model. */ + languageCodes?: Vapi.AssemblyAiTranscriberLanguageCodesItem[] | undefined; /** * This is the speech model used for the streaming session. - * Note: Keyterms prompting is not supported with multilingual streaming. + * Keyterms prompting is supported on universal-streaming-english and universal-3-5-pro. + * universal-3-5-pro is AssemblyAI's most accurate voice-agent model. * @default 'universal-streaming-english' */ speechModel?: Vapi.AssemblyAiTranscriberSpeechModel | undefined; @@ -60,7 +76,7 @@ export interface AssemblyAiTranscriber { /** * Keyterms prompting improves recognition accuracy for specific words and phrases. * Can include up to 100 keyterms, each up to 50 characters. - * Costs an additional $0.04/hour when enabled. + * Costs an additional $0.04/hour on universal-streaming-english and is included at no extra cost on universal-3-5-pro. */ keytermsPrompt?: string[] | undefined; /** The duration of the end utterance silence threshold in milliseconds. */ diff --git a/src/api/types/AssemblyAiTranscriberLanguageCodesItem.ts b/src/api/types/AssemblyAiTranscriberLanguageCodesItem.ts new file mode 100644 index 00000000..5d623a18 --- /dev/null +++ b/src/api/types/AssemblyAiTranscriberLanguageCodesItem.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssemblyAiTranscriberLanguageCodesItem = { + En: "en", + Es: "es", + Fr: "fr", + De: "de", + It: "it", + Pt: "pt", + Tr: "tr", + Nl: "nl", + Sv: "sv", + No: "no", + Da: "da", + Fi: "fi", + Hi: "hi", + Vi: "vi", + Ar: "ar", + He: "he", + Ja: "ja", + Zh: "zh", +} as const; +export type AssemblyAiTranscriberLanguageCodesItem = + (typeof AssemblyAiTranscriberLanguageCodesItem)[keyof typeof AssemblyAiTranscriberLanguageCodesItem]; diff --git a/src/api/types/AssemblyAiTranscriberMode.ts b/src/api/types/AssemblyAiTranscriberMode.ts new file mode 100644 index 00000000..02b87774 --- /dev/null +++ b/src/api/types/AssemblyAiTranscriberMode.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model. + * + * @default 'balanced' + */ +export const AssemblyAiTranscriberMode = { + MaxAccuracy: "max_accuracy", + MinLatency: "min_latency", + Balanced: "balanced", +} as const; +export type AssemblyAiTranscriberMode = (typeof AssemblyAiTranscriberMode)[keyof typeof AssemblyAiTranscriberMode]; diff --git a/src/api/types/AssemblyAiTranscriberSpeechModel.ts b/src/api/types/AssemblyAiTranscriberSpeechModel.ts index f91e289f..99791199 100644 --- a/src/api/types/AssemblyAiTranscriberSpeechModel.ts +++ b/src/api/types/AssemblyAiTranscriberSpeechModel.ts @@ -2,12 +2,14 @@ /** * This is the speech model used for the streaming session. - * Note: Keyterms prompting is not supported with multilingual streaming. + * Keyterms prompting is supported on universal-streaming-english and universal-3-5-pro. + * universal-3-5-pro is AssemblyAI's most accurate voice-agent model. * @default 'universal-streaming-english' */ export const AssemblyAiTranscriberSpeechModel = { UniversalStreamingEnglish: "universal-streaming-english", UniversalStreamingMultilingual: "universal-streaming-multilingual", + Universal35Pro: "universal-3-5-pro", } as const; export type AssemblyAiTranscriberSpeechModel = (typeof AssemblyAiTranscriberSpeechModel)[keyof typeof AssemblyAiTranscriberSpeechModel]; diff --git a/src/api/types/Assistant.ts b/src/api/types/Assistant.ts index 68b5f5ec..f603787d 100644 --- a/src/api/types/Assistant.ts +++ b/src/api/types/Assistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved assistant configuration returned by the Vapi API. It defines how the assistant listens, reasons, speaks, handles conversations, sends events, and produces artifacts and analysis. + */ export interface Assistant { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.AssistantTranscriber | undefined; @@ -15,6 +18,7 @@ export interface Assistant { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -65,6 +69,13 @@ export interface Assistant { credentials?: Vapi.AssistantCredentialsItem[] | undefined; /** This is a set of actions that will be performed on certain events. */ hooks?: Vapi.AssistantHooksItem[] | undefined; + /** + * This is the latest version label (e.g. `v3`) of the assistant in the + * version history. `null` while the org is not yet + * onboarded to versioning, or for assistants that have not yet been + * published under it. + */ + latestVersion?: (string | null) | undefined; /** * This is the name of the assistant. * @@ -85,6 +96,7 @@ export interface Assistant { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -147,6 +159,7 @@ export interface Assistant { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; /** This is the unique identifier for the assistant. */ id: string; diff --git a/src/api/types/AssistantActivation.ts b/src/api/types/AssistantActivation.ts index 1b8aaf5c..2864d525 100644 --- a/src/api/types/AssistantActivation.ts +++ b/src/api/types/AssistantActivation.ts @@ -1,6 +1,16 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Identifies an assistant that became active during a call. + */ export interface AssistantActivation { + /** + * This is the version label (e.g. `v3`) of the assistant active when + * the activation row was recorded. `null` for inline assistants, + * orgs not on assistant versioning, and parent assistants that have + * not yet been published under it. + */ + assistantVersion?: (string | null) | undefined; /** This is the name of the assistant that was active during the call. */ assistantName: string; /** This is the ID of the assistant that was active during the call. */ diff --git a/src/api/types/AssistantCredentialsItem.ts b/src/api/types/AssistantCredentialsItem.ts index 38d67fba..857c036b 100644 --- a/src/api/types/AssistantCredentialsItem.ts +++ b/src/api/types/AssistantCredentialsItem.ts @@ -34,6 +34,7 @@ export type AssistantCredentialsItem = | Vapi.AssistantCredentialsItem.RimeAi | Vapi.AssistantCredentialsItem.Runpod | Vapi.AssistantCredentialsItem.S3 + | Vapi.AssistantCredentialsItem.S3Compatible | Vapi.AssistantCredentialsItem.Supabase | Vapi.AssistantCredentialsItem.SmallestAi | Vapi.AssistantCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type AssistantCredentialsItem = | Vapi.AssistantCredentialsItem.Webhook | Vapi.AssistantCredentialsItem.CustomCredential | Vapi.AssistantCredentialsItem.Xai + | Vapi.AssistantCredentialsItem.Microsoft | Vapi.AssistantCredentialsItem.Neuphonic | Vapi.AssistantCredentialsItem.Hume | Vapi.AssistantCredentialsItem.Mistral | Vapi.AssistantCredentialsItem.Speechmatics | Vapi.AssistantCredentialsItem.Soniox - | Vapi.AssistantCredentialsItem.Trieve | Vapi.AssistantCredentialsItem.GoogleCalendarOauth2Client | Vapi.AssistantCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.AssistantCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace AssistantCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace AssistantCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace AssistantCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace AssistantCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.AssistantCredentialsItem._11Labs + | Vapi.AssistantCredentialsItem.Anthropic + | Vapi.AssistantCredentialsItem.AnthropicBedrock + | Vapi.AssistantCredentialsItem.Anyscale + | Vapi.AssistantCredentialsItem.AssemblyAi + | Vapi.AssistantCredentialsItem.AzureOpenai + | Vapi.AssistantCredentialsItem.Azure + | Vapi.AssistantCredentialsItem.ByoSipTrunk + | Vapi.AssistantCredentialsItem.Cartesia + | Vapi.AssistantCredentialsItem.Cerebras + | Vapi.AssistantCredentialsItem.Cloudflare + | Vapi.AssistantCredentialsItem.CustomLlm + | Vapi.AssistantCredentialsItem.Deepgram + | Vapi.AssistantCredentialsItem.Deepinfra + | Vapi.AssistantCredentialsItem.DeepSeek + | Vapi.AssistantCredentialsItem.Gcp + | Vapi.AssistantCredentialsItem.Gladia + | Vapi.AssistantCredentialsItem.Gohighlevel + | Vapi.AssistantCredentialsItem.Google + | Vapi.AssistantCredentialsItem.Groq + | Vapi.AssistantCredentialsItem.InflectionAi + | Vapi.AssistantCredentialsItem.Langfuse + | Vapi.AssistantCredentialsItem.Lmnt + | Vapi.AssistantCredentialsItem.Make + | Vapi.AssistantCredentialsItem.Openai + | Vapi.AssistantCredentialsItem.Openrouter + | Vapi.AssistantCredentialsItem.PerplexityAi + | Vapi.AssistantCredentialsItem.Playht + | Vapi.AssistantCredentialsItem.RimeAi + | Vapi.AssistantCredentialsItem.Runpod + | Vapi.AssistantCredentialsItem.S3 + | Vapi.AssistantCredentialsItem.S3Compatible + | Vapi.AssistantCredentialsItem.Supabase + | Vapi.AssistantCredentialsItem.SmallestAi + | Vapi.AssistantCredentialsItem.Tavus + | Vapi.AssistantCredentialsItem.TogetherAi + | Vapi.AssistantCredentialsItem.Twilio + | Vapi.AssistantCredentialsItem.Vonage + | Vapi.AssistantCredentialsItem.Webhook + | Vapi.AssistantCredentialsItem.CustomCredential + | Vapi.AssistantCredentialsItem.Xai + | Vapi.AssistantCredentialsItem.Microsoft + | Vapi.AssistantCredentialsItem.Neuphonic + | Vapi.AssistantCredentialsItem.Hume + | Vapi.AssistantCredentialsItem.Mistral + | Vapi.AssistantCredentialsItem.Speechmatics + | Vapi.AssistantCredentialsItem.Soniox + | Vapi.AssistantCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantCredentialsItem.Inworld + | Vapi.AssistantCredentialsItem.Minimax + | Vapi.AssistantCredentialsItem.Wellsaid + | Vapi.AssistantCredentialsItem.Email + | Vapi.AssistantCredentialsItem.SlackWebhook; } diff --git a/src/api/types/AssistantCustomEndpointingRule.ts b/src/api/types/AssistantCustomEndpointingRule.ts index 34ee2d38..643d72f2 100644 --- a/src/api/types/AssistantCustomEndpointingRule.ts +++ b/src/api/types/AssistantCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches the assistant's last message and applies a configured timeout. + */ export interface AssistantCustomEndpointingRule { /** * This is the regex pattern to match. diff --git a/src/api/types/AssistantDraft.ts b/src/api/types/AssistantDraft.ts new file mode 100644 index 00000000..0b4a0a3a --- /dev/null +++ b/src/api/types/AssistantDraft.ts @@ -0,0 +1,163 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface AssistantDraft { + /** These are the options for the assistant's transcriber. */ + transcriber?: Vapi.AssistantDraftTranscriber | undefined; + /** These are the options for the assistant's LLM. */ + model?: Vapi.AssistantDraftModel | undefined; + /** These are the options for the assistant's voice. */ + voice?: Vapi.AssistantDraftVoice | undefined; + /** + * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). + * + * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. + */ + firstMessage?: string | undefined; + firstMessageInterruptionsEnabled?: boolean | undefined; + /** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.AssistantDraftFirstMessageMode | undefined; + /** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ + voicemailDetection?: Vapi.AssistantDraftVoicemailDetection | undefined; + /** These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema. */ + clientMessages?: Vapi.AssistantDraftClientMessagesItem[] | undefined; + /** These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema. */ + serverMessages?: Vapi.AssistantDraftServerMessagesItem[] | undefined; + /** + * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. + * + * @default 600 (10 minutes) + */ + maxDurationSeconds?: number | undefined; + /** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ + backgroundSound?: Vapi.AssistantDraftBackgroundSound | undefined; + /** + * This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. + * + * @default false + */ + modelOutputInMessagesEnabled?: boolean | undefined; + /** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */ + transportConfigurations?: Vapi.TransportConfigurationTwilio[] | undefined; + /** + * This is the plan for observability of assistant's calls. + * + * Currently, only Langfuse is supported. + */ + observabilityPlan?: Vapi.LangfuseObservabilityPlan | undefined; + /** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */ + credentials?: Vapi.AssistantDraftCredentialsItem[] | undefined; + /** This is a set of actions that will be performed on certain events. */ + hooks?: Vapi.AssistantDraftHooksItem[] | undefined; + /** + * This is the name of the assistant. + * + * This is required when you want to transfer between assistants in a call. + */ + name?: string | undefined; + /** + * This is the message that the assistant will say if the call is forwarded to voicemail. + * + * If unspecified, it will hang up. + */ + voicemailMessage?: string | undefined; + /** + * This is the message that the assistant will say if it ends the call. + * + * If unspecified, it will hang up without saying anything. + */ + endCallMessage?: string | undefined; + /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ + endCallPhrases?: string[] | undefined; + compliancePlan?: Vapi.CompliancePlan | undefined; + /** This is for metadata you want to store on the assistant. */ + metadata?: Record | undefined; + /** + * This enables filtering of noise and background speech while the user is talking. + * + * Features: + * - Smart denoising using Krisp + * - Fourier denoising + * + * Smart denoising can be combined with or used independently of Fourier denoising. + * + * Order of precedence: + * - Smart denoising + * - Fourier denoising + */ + backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan | undefined; + /** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */ + analysisPlan?: Vapi.AnalysisPlan | undefined; + /** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */ + artifactPlan?: Vapi.ArtifactPlan | undefined; + /** + * This is the plan for when the assistant should start talking. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to start talking after the customer is done speaking. + * - The assistant is too fast to start talking after the customer is done speaking. + * - The assistant is so fast that it's actually interrupting the customer. + */ + startSpeakingPlan?: Vapi.StartSpeakingPlan | undefined; + /** + * This is the plan for when assistant should stop talking on customer interruption. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to recognize customer's interruption. + * - The assistant is too fast to recognize customer's interruption. + * - The assistant is getting interrupted by phrases that are just acknowledgments. + * - The assistant is getting interrupted by background noises. + * - The assistant is not properly stopping -- it starts talking right after getting interrupted. + */ + stopSpeakingPlan?: Vapi.StopSpeakingPlan | undefined; + /** + * This is the plan for real-time monitoring of the assistant's calls. + * + * Usage: + * - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. + * - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`. + * - To attach monitors to the assistant, set `monitorPlan.monitorIds` to the set of monitor ids. + */ + monitorPlan?: Vapi.MonitorPlan | undefined; + /** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */ + credentialIds?: string[] | undefined; + /** + * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. + * + * The order of precedence is: + * + * 1. assistant.server.url + * 2. phoneNumber.serverUrl + * 3. org.serverUrl + */ + server?: Vapi.Server | undefined; + keypadInputPlan?: Vapi.KeypadInputPlan | undefined; + /** Server-resolved baseVersion (always set after POST). */ + baseVersion: string; + /** Surrogate key used as `draftId` in URLs. */ + id: string; + /** Org this draft belongs to. */ + orgId: string; + /** Parent assistant the draft was forked from. FK to assistant.id ON DELETE CASCADE. */ + assistantId: string; + /** Email when JWT, null when API or external JWT. Set on POST, never rewritten on PATCH. */ + createdBy?: (string | null) | undefined; + createdAt: string; + updatedAt: string; +} diff --git a/src/api/types/AssistantDraftBackgroundSound.ts b/src/api/types/AssistantDraftBackgroundSound.ts new file mode 100644 index 00000000..4c51401b --- /dev/null +++ b/src/api/types/AssistantDraftBackgroundSound.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ +export type AssistantDraftBackgroundSound = Vapi.AssistantDraftBackgroundSoundZero | string; diff --git a/src/api/types/AssistantDraftBackgroundSoundZero.ts b/src/api/types/AssistantDraftBackgroundSoundZero.ts new file mode 100644 index 00000000..ac889997 --- /dev/null +++ b/src/api/types/AssistantDraftBackgroundSoundZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantDraftBackgroundSoundZero = { + Off: "off", + Office: "office", +} as const; +export type AssistantDraftBackgroundSoundZero = + (typeof AssistantDraftBackgroundSoundZero)[keyof typeof AssistantDraftBackgroundSoundZero]; diff --git a/src/api/types/AssistantDraftClientMessagesItem.ts b/src/api/types/AssistantDraftClientMessagesItem.ts new file mode 100644 index 00000000..629c6884 --- /dev/null +++ b/src/api/types/AssistantDraftClientMessagesItem.ts @@ -0,0 +1,25 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantDraftClientMessagesItem = { + ConversationUpdate: "conversation-update", + AssistantSpeechStarted: "assistant.speechStarted", + FunctionCall: "function-call", + FunctionCallResult: "function-call-result", + Hang: "hang", + LanguageChanged: "language-changed", + Metadata: "metadata", + ModelOutput: "model-output", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + ToolCalls: "tool-calls", + ToolCallsResult: "tool-calls-result", + ToolCompleted: "tool.completed", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + WorkflowNodeStarted: "workflow.node.started", + AssistantStarted: "assistant.started", +} as const; +export type AssistantDraftClientMessagesItem = + (typeof AssistantDraftClientMessagesItem)[keyof typeof AssistantDraftClientMessagesItem]; diff --git a/src/api/types/AssistantDraftConflictResponseDto.ts b/src/api/types/AssistantDraftConflictResponseDto.ts new file mode 100644 index 00000000..6b75c97e --- /dev/null +++ b/src/api/types/AssistantDraftConflictResponseDto.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface AssistantDraftConflictResponseDto { + existingDraftId: string | null; + error: string; + message: string; +} diff --git a/src/api/types/AssistantDraftCredentialsItem.ts b/src/api/types/AssistantDraftCredentialsItem.ts new file mode 100644 index 00000000..51e2043d --- /dev/null +++ b/src/api/types/AssistantDraftCredentialsItem.ts @@ -0,0 +1,352 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type AssistantDraftCredentialsItem = + | Vapi.AssistantDraftCredentialsItem._11Labs + | Vapi.AssistantDraftCredentialsItem.Anthropic + | Vapi.AssistantDraftCredentialsItem.AnthropicBedrock + | Vapi.AssistantDraftCredentialsItem.Anyscale + | Vapi.AssistantDraftCredentialsItem.AssemblyAi + | Vapi.AssistantDraftCredentialsItem.AzureOpenai + | Vapi.AssistantDraftCredentialsItem.Azure + | Vapi.AssistantDraftCredentialsItem.ByoSipTrunk + | Vapi.AssistantDraftCredentialsItem.Cartesia + | Vapi.AssistantDraftCredentialsItem.Cerebras + | Vapi.AssistantDraftCredentialsItem.Cloudflare + | Vapi.AssistantDraftCredentialsItem.CustomLlm + | Vapi.AssistantDraftCredentialsItem.Deepgram + | Vapi.AssistantDraftCredentialsItem.Deepinfra + | Vapi.AssistantDraftCredentialsItem.DeepSeek + | Vapi.AssistantDraftCredentialsItem.Gcp + | Vapi.AssistantDraftCredentialsItem.Gladia + | Vapi.AssistantDraftCredentialsItem.Gohighlevel + | Vapi.AssistantDraftCredentialsItem.Google + | Vapi.AssistantDraftCredentialsItem.Groq + | Vapi.AssistantDraftCredentialsItem.InflectionAi + | Vapi.AssistantDraftCredentialsItem.Langfuse + | Vapi.AssistantDraftCredentialsItem.Lmnt + | Vapi.AssistantDraftCredentialsItem.Make + | Vapi.AssistantDraftCredentialsItem.Openai + | Vapi.AssistantDraftCredentialsItem.Openrouter + | Vapi.AssistantDraftCredentialsItem.PerplexityAi + | Vapi.AssistantDraftCredentialsItem.Playht + | Vapi.AssistantDraftCredentialsItem.RimeAi + | Vapi.AssistantDraftCredentialsItem.Runpod + | Vapi.AssistantDraftCredentialsItem.S3 + | Vapi.AssistantDraftCredentialsItem.S3Compatible + | Vapi.AssistantDraftCredentialsItem.Supabase + | Vapi.AssistantDraftCredentialsItem.SmallestAi + | Vapi.AssistantDraftCredentialsItem.Tavus + | Vapi.AssistantDraftCredentialsItem.TogetherAi + | Vapi.AssistantDraftCredentialsItem.Twilio + | Vapi.AssistantDraftCredentialsItem.Vonage + | Vapi.AssistantDraftCredentialsItem.Webhook + | Vapi.AssistantDraftCredentialsItem.CustomCredential + | Vapi.AssistantDraftCredentialsItem.Xai + | Vapi.AssistantDraftCredentialsItem.Microsoft + | Vapi.AssistantDraftCredentialsItem.Neuphonic + | Vapi.AssistantDraftCredentialsItem.Hume + | Vapi.AssistantDraftCredentialsItem.Mistral + | Vapi.AssistantDraftCredentialsItem.Speechmatics + | Vapi.AssistantDraftCredentialsItem.Soniox + | Vapi.AssistantDraftCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantDraftCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.Inworld + | Vapi.AssistantDraftCredentialsItem.Minimax + | Vapi.AssistantDraftCredentialsItem.Wellsaid + | Vapi.AssistantDraftCredentialsItem.Email + | Vapi.AssistantDraftCredentialsItem.SlackWebhook; + +export namespace AssistantDraftCredentialsItem { + export interface _11Labs extends Vapi.CreateElevenLabsCredentialDto { + provider: "11labs"; + } + + export interface Anthropic extends Vapi.CreateAnthropicCredentialDto { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.CreateAnthropicBedrockCredentialDto { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.CreateAnyscaleCredentialDto { + provider: "anyscale"; + } + + export interface AssemblyAi extends Vapi.CreateAssemblyAiCredentialDto { + provider: "assembly-ai"; + } + + export interface AzureOpenai extends Vapi.CreateAzureOpenAiCredentialDto { + provider: "azure-openai"; + } + + export interface Azure extends Vapi.CreateAzureCredentialDto { + provider: "azure"; + } + + export interface ByoSipTrunk extends Vapi.CreateByoSipTrunkCredentialDto { + provider: "byo-sip-trunk"; + } + + export interface Cartesia extends Vapi.CreateCartesiaCredentialDto { + provider: "cartesia"; + } + + export interface Cerebras extends Vapi.CreateCerebrasCredentialDto { + provider: "cerebras"; + } + + export interface Cloudflare extends Vapi.CreateCloudflareCredentialDto { + provider: "cloudflare"; + } + + export interface CustomLlm extends Vapi.CreateCustomLlmCredentialDto { + provider: "custom-llm"; + } + + export interface Deepgram extends Vapi.CreateDeepgramCredentialDto { + provider: "deepgram"; + } + + export interface Deepinfra extends Vapi.CreateDeepInfraCredentialDto { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.CreateDeepSeekCredentialDto { + provider: "deep-seek"; + } + + export interface Gcp extends Vapi.CreateGcpCredentialDto { + provider: "gcp"; + } + + export interface Gladia extends Vapi.CreateGladiaCredentialDto { + provider: "gladia"; + } + + export interface Gohighlevel extends Vapi.CreateGoHighLevelCredentialDto { + provider: "gohighlevel"; + } + + export interface Google extends Vapi.CreateGoogleCredentialDto { + provider: "google"; + } + + export interface Groq extends Vapi.CreateGroqCredentialDto { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.CreateInflectionAiCredentialDto { + provider: "inflection-ai"; + } + + export interface Langfuse extends Vapi.CreateLangfuseCredentialDto { + provider: "langfuse"; + } + + export interface Lmnt extends Vapi.CreateLmntCredentialDto { + provider: "lmnt"; + } + + export interface Make extends Vapi.CreateMakeCredentialDto { + provider: "make"; + } + + export interface Openai extends Vapi.CreateOpenAiCredentialDto { + provider: "openai"; + } + + export interface Openrouter extends Vapi.CreateOpenRouterCredentialDto { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.CreatePerplexityAiCredentialDto { + provider: "perplexity-ai"; + } + + export interface Playht extends Vapi.CreatePlayHtCredentialDto { + provider: "playht"; + } + + export interface RimeAi extends Vapi.CreateRimeAiCredentialDto { + provider: "rime-ai"; + } + + export interface Runpod extends Vapi.CreateRunpodCredentialDto { + provider: "runpod"; + } + + export interface S3 extends Vapi.CreateS3CredentialDto { + provider: "s3"; + } + + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { + provider: "supabase"; + } + + export interface SmallestAi extends Vapi.CreateSmallestAiCredentialDto { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.CreateTavusCredentialDto { + provider: "tavus"; + } + + export interface TogetherAi extends Vapi.CreateTogetherAiCredentialDto { + provider: "together-ai"; + } + + export interface Twilio extends Vapi.CreateTwilioCredentialDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonageCredentialDto { + provider: "vonage"; + } + + export interface Webhook extends Vapi.CreateWebhookCredentialDto { + provider: "webhook"; + } + + export interface CustomCredential extends Vapi.CreateCustomCredentialDto { + provider: "custom-credential"; + } + + export interface Xai extends Vapi.CreateXAiCredentialDto { + provider: "xai"; + } + + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { + provider: "neuphonic"; + } + + export interface Hume extends Vapi.CreateHumeCredentialDto { + provider: "hume"; + } + + export interface Mistral extends Vapi.CreateMistralCredentialDto { + provider: "mistral"; + } + + export interface Speechmatics extends Vapi.CreateSpeechmaticsCredentialDto { + provider: "speechmatics"; + } + + export interface Soniox extends Vapi.CreateSonioxCredentialDto { + provider: "soniox"; + } + + export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { + provider: "google.calendar.oauth2-client"; + } + + export interface GoogleCalendarOauth2Authorization + extends Vapi.CreateGoogleCalendarOAuth2AuthorizationCredentialDto { + provider: "google.calendar.oauth2-authorization"; + } + + export interface GoogleSheetsOauth2Authorization extends Vapi.CreateGoogleSheetsOAuth2AuthorizationCredentialDto { + provider: "google.sheets.oauth2-authorization"; + } + + export interface SlackOauth2Authorization extends Vapi.CreateSlackOAuth2AuthorizationCredentialDto { + provider: "slack.oauth2-authorization"; + } + + export interface GhlOauth2Authorization extends Vapi.CreateGoHighLevelMcpCredentialDto { + provider: "ghl.oauth2-authorization"; + } + + export interface Inworld extends Vapi.CreateInworldCredentialDto { + provider: "inworld"; + } + + export interface Minimax extends Vapi.CreateMinimaxCredentialDto { + provider: "minimax"; + } + + export interface Wellsaid extends Vapi.CreateWellSaidCredentialDto { + provider: "wellsaid"; + } + + export interface Email extends Vapi.CreateEmailCredentialDto { + provider: "email"; + } + + export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { + provider: "slack-webhook"; + } + + export type Response = + | Vapi.AssistantDraftCredentialsItem._11Labs + | Vapi.AssistantDraftCredentialsItem.Anthropic + | Vapi.AssistantDraftCredentialsItem.AnthropicBedrock + | Vapi.AssistantDraftCredentialsItem.Anyscale + | Vapi.AssistantDraftCredentialsItem.AssemblyAi + | Vapi.AssistantDraftCredentialsItem.AzureOpenai + | Vapi.AssistantDraftCredentialsItem.Azure + | Vapi.AssistantDraftCredentialsItem.ByoSipTrunk + | Vapi.AssistantDraftCredentialsItem.Cartesia + | Vapi.AssistantDraftCredentialsItem.Cerebras + | Vapi.AssistantDraftCredentialsItem.Cloudflare + | Vapi.AssistantDraftCredentialsItem.CustomLlm + | Vapi.AssistantDraftCredentialsItem.Deepgram + | Vapi.AssistantDraftCredentialsItem.Deepinfra + | Vapi.AssistantDraftCredentialsItem.DeepSeek + | Vapi.AssistantDraftCredentialsItem.Gcp + | Vapi.AssistantDraftCredentialsItem.Gladia + | Vapi.AssistantDraftCredentialsItem.Gohighlevel + | Vapi.AssistantDraftCredentialsItem.Google + | Vapi.AssistantDraftCredentialsItem.Groq + | Vapi.AssistantDraftCredentialsItem.InflectionAi + | Vapi.AssistantDraftCredentialsItem.Langfuse + | Vapi.AssistantDraftCredentialsItem.Lmnt + | Vapi.AssistantDraftCredentialsItem.Make + | Vapi.AssistantDraftCredentialsItem.Openai + | Vapi.AssistantDraftCredentialsItem.Openrouter + | Vapi.AssistantDraftCredentialsItem.PerplexityAi + | Vapi.AssistantDraftCredentialsItem.Playht + | Vapi.AssistantDraftCredentialsItem.RimeAi + | Vapi.AssistantDraftCredentialsItem.Runpod + | Vapi.AssistantDraftCredentialsItem.S3 + | Vapi.AssistantDraftCredentialsItem.S3Compatible + | Vapi.AssistantDraftCredentialsItem.Supabase + | Vapi.AssistantDraftCredentialsItem.SmallestAi + | Vapi.AssistantDraftCredentialsItem.Tavus + | Vapi.AssistantDraftCredentialsItem.TogetherAi + | Vapi.AssistantDraftCredentialsItem.Twilio + | Vapi.AssistantDraftCredentialsItem.Vonage + | Vapi.AssistantDraftCredentialsItem.Webhook + | Vapi.AssistantDraftCredentialsItem.CustomCredential + | Vapi.AssistantDraftCredentialsItem.Xai + | Vapi.AssistantDraftCredentialsItem.Microsoft + | Vapi.AssistantDraftCredentialsItem.Neuphonic + | Vapi.AssistantDraftCredentialsItem.Hume + | Vapi.AssistantDraftCredentialsItem.Mistral + | Vapi.AssistantDraftCredentialsItem.Speechmatics + | Vapi.AssistantDraftCredentialsItem.Soniox + | Vapi.AssistantDraftCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantDraftCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantDraftCredentialsItem.Inworld + | Vapi.AssistantDraftCredentialsItem.Minimax + | Vapi.AssistantDraftCredentialsItem.Wellsaid + | Vapi.AssistantDraftCredentialsItem.Email + | Vapi.AssistantDraftCredentialsItem.SlackWebhook; +} diff --git a/src/api/types/AssistantDraftFirstMessageMode.ts b/src/api/types/AssistantDraftFirstMessageMode.ts new file mode 100644 index 00000000..8926cda8 --- /dev/null +++ b/src/api/types/AssistantDraftFirstMessageMode.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ +export const AssistantDraftFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantSpeaksFirstWithModelGeneratedMessage: "assistant-speaks-first-with-model-generated-message", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type AssistantDraftFirstMessageMode = + (typeof AssistantDraftFirstMessageMode)[keyof typeof AssistantDraftFirstMessageMode]; diff --git a/src/api/types/AssistantDraftHooksItem.ts b/src/api/types/AssistantDraftHooksItem.ts new file mode 100644 index 00000000..da1a096c --- /dev/null +++ b/src/api/types/AssistantDraftHooksItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type AssistantDraftHooksItem = + | Vapi.CallHookCallEnding + | Vapi.CallHookAssistantSpeechInterrupted + | Vapi.CallHookCustomerSpeechInterrupted + | Vapi.CallHookCustomerSpeechTimeout + | Vapi.SessionCreatedHook; diff --git a/src/api/types/AssistantDraftModel.ts b/src/api/types/AssistantDraftModel.ts new file mode 100644 index 00000000..8e514aa7 --- /dev/null +++ b/src/api/types/AssistantDraftModel.ts @@ -0,0 +1,117 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's LLM. + */ +export type AssistantDraftModel = + | Vapi.AssistantDraftModel.Anthropic + | Vapi.AssistantDraftModel.AnthropicBedrock + | Vapi.AssistantDraftModel.Anyscale + | Vapi.AssistantDraftModel.Cerebras + | Vapi.AssistantDraftModel.CustomLlm + | Vapi.AssistantDraftModel.Deepinfra + | Vapi.AssistantDraftModel.DeepSeek + | Vapi.AssistantDraftModel.Google + | Vapi.AssistantDraftModel.Groq + | Vapi.AssistantDraftModel.InflectionAi + | Vapi.AssistantDraftModel.Minimax + | Vapi.AssistantDraftModel.Openai + | Vapi.AssistantDraftModel.Openrouter + | Vapi.AssistantDraftModel.PerplexityAi + | Vapi.AssistantDraftModel.TogetherAi + | Vapi.AssistantDraftModel.Xai + | Vapi.AssistantDraftModel.Vapi; + +export namespace AssistantDraftModel { + export interface Anthropic extends Vapi.AnthropicModel { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.AnthropicBedrockModel { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.AnyscaleModel { + provider: "anyscale"; + } + + export interface Cerebras extends Vapi.CerebrasModel { + provider: "cerebras"; + } + + export interface CustomLlm extends Vapi.CustomLlmModel { + provider: "custom-llm"; + } + + export interface Deepinfra extends Vapi.DeepInfraModel { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.DeepSeekModel { + provider: "deep-seek"; + } + + export interface Google extends Vapi.GoogleModel { + provider: "google"; + } + + export interface Groq extends Vapi.GroqModel { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.InflectionAiModel { + provider: "inflection-ai"; + } + + export interface Minimax extends Vapi.MinimaxLlmModel { + provider: "minimax"; + } + + export interface Openai extends Vapi.OpenAiModel { + provider: "openai"; + } + + export interface Openrouter extends Vapi.OpenRouterModel { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.PerplexityAiModel { + provider: "perplexity-ai"; + } + + export interface TogetherAi extends Vapi.TogetherAiModel { + provider: "together-ai"; + } + + export interface Xai extends Vapi.XaiModel { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.AssistantDraftModel.Anthropic + | Vapi.AssistantDraftModel.AnthropicBedrock + | Vapi.AssistantDraftModel.Anyscale + | Vapi.AssistantDraftModel.Cerebras + | Vapi.AssistantDraftModel.CustomLlm + | Vapi.AssistantDraftModel.Deepinfra + | Vapi.AssistantDraftModel.DeepSeek + | Vapi.AssistantDraftModel.Google + | Vapi.AssistantDraftModel.Groq + | Vapi.AssistantDraftModel.InflectionAi + | Vapi.AssistantDraftModel.Minimax + | Vapi.AssistantDraftModel.Openai + | Vapi.AssistantDraftModel.Openrouter + | Vapi.AssistantDraftModel.PerplexityAi + | Vapi.AssistantDraftModel.TogetherAi + | Vapi.AssistantDraftModel.Xai + | Vapi.AssistantDraftModel.Vapi; +} diff --git a/src/api/types/AssistantDraftPaginatedMetadata.ts b/src/api/types/AssistantDraftPaginatedMetadata.ts new file mode 100644 index 00000000..f18b01d8 --- /dev/null +++ b/src/api/types/AssistantDraftPaginatedMetadata.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface AssistantDraftPaginatedMetadata { + nextCursor: string | null; + hasNextPage: boolean; + limit: number; +} diff --git a/src/api/types/AssistantDraftPaginatedResponse.ts b/src/api/types/AssistantDraftPaginatedResponse.ts new file mode 100644 index 00000000..a4024390 --- /dev/null +++ b/src/api/types/AssistantDraftPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface AssistantDraftPaginatedResponse { + results: Vapi.AssistantDraft[]; + metadata: Vapi.AssistantDraftPaginatedMetadata; +} diff --git a/src/api/types/AssistantDraftServerMessagesItem.ts b/src/api/types/AssistantDraftServerMessagesItem.ts new file mode 100644 index 00000000..39086d2d --- /dev/null +++ b/src/api/types/AssistantDraftServerMessagesItem.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantDraftServerMessagesItem = { + AssistantStarted: "assistant.started", + AssistantSpeechStarted: "assistant.speechStarted", + ConversationUpdate: "conversation-update", + EndOfCallReport: "end-of-call-report", + FunctionCall: "function-call", + Hang: "hang", + LanguageChanged: "language-changed", + LanguageChangeDetected: "language-change-detected", + ModelOutput: "model-output", + PhoneCallControl: "phone-call-control", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + TranscriptTranscriptTypeFinal: 'transcript[transcriptType="final"]', + ToolCalls: "tool-calls", + TransferDestinationRequest: "transfer-destination-request", + HandoffDestinationRequest: "handoff-destination-request", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + ChatCreated: "chat.created", + ChatDeleted: "chat.deleted", + SessionCreated: "session.created", + SessionUpdated: "session.updated", + SessionDeleted: "session.deleted", + CallDeleted: "call.deleted", + CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", +} as const; +export type AssistantDraftServerMessagesItem = + (typeof AssistantDraftServerMessagesItem)[keyof typeof AssistantDraftServerMessagesItem]; diff --git a/src/api/types/AssistantDraftTranscriber.ts b/src/api/types/AssistantDraftTranscriber.ts new file mode 100644 index 00000000..777baed7 --- /dev/null +++ b/src/api/types/AssistantDraftTranscriber.ts @@ -0,0 +1,80 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's transcriber. + */ +export type AssistantDraftTranscriber = + | Vapi.AssistantDraftTranscriber.AssemblyAi + | Vapi.AssistantDraftTranscriber.Azure + | Vapi.AssistantDraftTranscriber.CustomTranscriber + | Vapi.AssistantDraftTranscriber.Deepgram + | Vapi.AssistantDraftTranscriber._11Labs + | Vapi.AssistantDraftTranscriber.Gladia + | Vapi.AssistantDraftTranscriber.Google + | Vapi.AssistantDraftTranscriber.Speechmatics + | Vapi.AssistantDraftTranscriber.Talkscriber + | Vapi.AssistantDraftTranscriber.Openai + | Vapi.AssistantDraftTranscriber.Cartesia + | Vapi.AssistantDraftTranscriber.Soniox + | Vapi.AssistantDraftTranscriber.Xai + | Vapi.AssistantDraftTranscriber.Vapi; + +export namespace AssistantDraftTranscriber { + export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { + provider: "assembly-ai"; + } + + export interface Azure extends Vapi.AzureSpeechTranscriber { + provider: "azure"; + } + + export interface CustomTranscriber extends Vapi.CustomTranscriber { + provider: "custom-transcriber"; + } + + export interface Deepgram extends Vapi.DeepgramTranscriber { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsTranscriber { + provider: "11labs"; + } + + export interface Gladia extends Vapi.GladiaTranscriber { + provider: "gladia"; + } + + export interface Google extends Vapi.GoogleTranscriber { + provider: "google"; + } + + export interface Speechmatics extends Vapi.SpeechmaticsTranscriber { + provider: "speechmatics"; + } + + export interface Talkscriber extends Vapi.TalkscriberTranscriber { + provider: "talkscriber"; + } + + export interface Openai extends Vapi.OpenAiTranscriber { + provider: "openai"; + } + + export interface Cartesia extends Vapi.CartesiaTranscriber { + provider: "cartesia"; + } + + export interface Soniox extends Vapi.SonioxTranscriber { + provider: "soniox"; + } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } +} diff --git a/src/api/types/AssistantDraftVoice.ts b/src/api/types/AssistantDraftVoice.ts new file mode 100644 index 00000000..7067276b --- /dev/null +++ b/src/api/types/AssistantDraftVoice.ts @@ -0,0 +1,110 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's voice. + */ +export type AssistantDraftVoice = + | Vapi.AssistantDraftVoice.Azure + | Vapi.AssistantDraftVoice.Cartesia + | Vapi.AssistantDraftVoice.CustomVoice + | Vapi.AssistantDraftVoice.Deepgram + | Vapi.AssistantDraftVoice._11Labs + | Vapi.AssistantDraftVoice.Hume + | Vapi.AssistantDraftVoice.Lmnt + | Vapi.AssistantDraftVoice.Neuphonic + | Vapi.AssistantDraftVoice.Openai + | Vapi.AssistantDraftVoice.Playht + | Vapi.AssistantDraftVoice.Wellsaid + | Vapi.AssistantDraftVoice.RimeAi + | Vapi.AssistantDraftVoice.SmallestAi + | Vapi.AssistantDraftVoice.Tavus + | Vapi.AssistantDraftVoice.Vapi + | Vapi.AssistantDraftVoice.Sesame + | Vapi.AssistantDraftVoice.Inworld + | Vapi.AssistantDraftVoice.Minimax + | Vapi.AssistantDraftVoice.Xai + | Vapi.AssistantDraftVoice.Microsoft; + +export namespace AssistantDraftVoice { + export interface Azure extends Vapi.AzureVoice { + provider: "azure"; + } + + export interface Cartesia extends Vapi.CartesiaVoice { + provider: "cartesia"; + } + + export interface CustomVoice extends Vapi.CustomVoice { + provider: "custom-voice"; + } + + export interface Deepgram extends Vapi.DeepgramVoice { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsVoice { + provider: "11labs"; + } + + export interface Hume extends Vapi.HumeVoice { + provider: "hume"; + } + + export interface Lmnt extends Vapi.LmntVoice { + provider: "lmnt"; + } + + export interface Neuphonic extends Vapi.NeuphonicVoice { + provider: "neuphonic"; + } + + export interface Openai extends Vapi.OpenAiVoice { + provider: "openai"; + } + + export interface Playht extends Vapi.PlayHtVoice { + provider: "playht"; + } + + export interface Wellsaid extends Vapi.WellSaidVoice { + provider: "wellsaid"; + } + + export interface RimeAi extends Vapi.RimeAiVoice { + provider: "rime-ai"; + } + + export interface SmallestAi extends Vapi.SmallestAiVoice { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.TavusVoice { + provider: "tavus"; + } + + export interface Vapi extends Vapi.VapiVoice { + provider: "vapi"; + } + + export interface Sesame extends Vapi.SesameVoice { + provider: "sesame"; + } + + export interface Inworld extends Vapi.InworldVoice { + provider: "inworld"; + } + + export interface Minimax extends Vapi.MinimaxVoice { + provider: "minimax"; + } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } +} diff --git a/src/api/types/AssistantDraftVoicemailDetection.ts b/src/api/types/AssistantDraftVoicemailDetection.ts new file mode 100644 index 00000000..e4c432af --- /dev/null +++ b/src/api/types/AssistantDraftVoicemailDetection.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ +export type AssistantDraftVoicemailDetection = + | Vapi.AssistantDraftVoicemailDetectionZero + | Vapi.GoogleVoicemailDetectionPlan + | Vapi.OpenAiVoicemailDetectionPlan + | Vapi.TwilioVoicemailDetectionPlan + | Vapi.VapiVoicemailDetectionPlan; diff --git a/src/api/types/AssistantDraftVoicemailDetectionZero.ts b/src/api/types/AssistantDraftVoicemailDetectionZero.ts new file mode 100644 index 00000000..cdb428b6 --- /dev/null +++ b/src/api/types/AssistantDraftVoicemailDetectionZero.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantDraftVoicemailDetectionZero = { + Off: "off", +} as const; +export type AssistantDraftVoicemailDetectionZero = + (typeof AssistantDraftVoicemailDetectionZero)[keyof typeof AssistantDraftVoicemailDetectionZero]; diff --git a/src/api/types/AssistantMessage.ts b/src/api/types/AssistantMessage.ts index afdc616a..f504ec8d 100644 --- a/src/api/types/AssistantMessage.ts +++ b/src/api/types/AssistantMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata. + */ export interface AssistantMessage { /** This is the role of the message author */ role: Vapi.AssistantMessageRole; diff --git a/src/api/types/AssistantMessageEvaluationContinuePlan.ts b/src/api/types/AssistantMessageEvaluationContinuePlan.ts index 229f7aea..e18caa0c 100644 --- a/src/api/types/AssistantMessageEvaluationContinuePlan.ts +++ b/src/api/types/AssistantMessageEvaluationContinuePlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional message overrides. + */ export interface AssistantMessageEvaluationContinuePlan { /** * This is whether the evaluation should exit if the assistant message evaluates to false. diff --git a/src/api/types/AssistantMessageJudgePlanAi.ts b/src/api/types/AssistantMessageJudgePlanAi.ts index 712a2bc0..8384e48a 100644 --- a/src/api/types/AssistantMessageJudgePlanAi.ts +++ b/src/api/types/AssistantMessageJudgePlanAi.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates an assistant message with an LLM judge and a configured evaluation model. + */ export interface AssistantMessageJudgePlanAi { /** * This is the model to use for the LLM-as-a-judge. diff --git a/src/api/types/AssistantMessageJudgePlanExact.ts b/src/api/types/AssistantMessageJudgePlanExact.ts index 0a1a19e8..1c450074 100644 --- a/src/api/types/AssistantMessageJudgePlanExact.ts +++ b/src/api/types/AssistantMessageJudgePlanExact.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates an assistant message using case-insensitive exact content matching and expected tool calls. + */ export interface AssistantMessageJudgePlanExact { /** * This is what that will be used to evaluate the model's message content. diff --git a/src/api/types/AssistantMessageJudgePlanRegex.ts b/src/api/types/AssistantMessageJudgePlanRegex.ts index c0e52e95..d5c28d32 100644 --- a/src/api/types/AssistantMessageJudgePlanRegex.ts +++ b/src/api/types/AssistantMessageJudgePlanRegex.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates assistant-message content and tool-call arguments using regular-expression patterns. + */ export interface AssistantMessageJudgePlanRegex { /** * This is what that will be used to evaluate the model's message content. diff --git a/src/api/types/AssistantModel.ts b/src/api/types/AssistantModel.ts index 09c595f5..b07a162c 100644 --- a/src/api/types/AssistantModel.ts +++ b/src/api/types/AssistantModel.ts @@ -21,7 +21,8 @@ export type AssistantModel = | Vapi.AssistantModel.Openrouter | Vapi.AssistantModel.PerplexityAi | Vapi.AssistantModel.TogetherAi - | Vapi.AssistantModel.Xai; + | Vapi.AssistantModel.Xai + | Vapi.AssistantModel.Vapi; export namespace AssistantModel { export interface Anthropic extends Vapi.AnthropicModel { @@ -87,4 +88,30 @@ export namespace AssistantModel { export interface Xai extends Vapi.XaiModel { provider: "xai"; } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.AssistantModel.Anthropic + | Vapi.AssistantModel.AnthropicBedrock + | Vapi.AssistantModel.Anyscale + | Vapi.AssistantModel.Cerebras + | Vapi.AssistantModel.CustomLlm + | Vapi.AssistantModel.Deepinfra + | Vapi.AssistantModel.DeepSeek + | Vapi.AssistantModel.Google + | Vapi.AssistantModel.Groq + | Vapi.AssistantModel.InflectionAi + | Vapi.AssistantModel.Minimax + | Vapi.AssistantModel.Openai + | Vapi.AssistantModel.Openrouter + | Vapi.AssistantModel.PerplexityAi + | Vapi.AssistantModel.TogetherAi + | Vapi.AssistantModel.Xai + | Vapi.AssistantModel.Vapi; } diff --git a/src/api/types/AssistantOverrides.ts b/src/api/types/AssistantOverrides.ts index adce6309..7ad8d157 100644 --- a/src/api/types/AssistantOverrides.ts +++ b/src/api/types/AssistantOverrides.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and server configuration. + */ export interface AssistantOverrides { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.AssistantOverridesTranscriber | undefined; @@ -15,6 +18,7 @@ export interface AssistantOverrides { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -65,6 +69,7 @@ export interface AssistantOverrides { credentials?: Vapi.AssistantOverridesCredentialsItem[] | undefined; /** This is a set of actions that will be performed on certain events. */ hooks?: Vapi.AssistantOverridesHooksItem[] | undefined; + /** Tools to append to the assistant's existing tool configuration. */ "tools:append"?: Vapi.AssistantOverridesToolsAppendItem[] | undefined; /** * These are values that will be used to replace the template variables in the assistant messages and other text-based fields. @@ -96,6 +101,7 @@ export interface AssistantOverrides { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings to apply, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -158,5 +164,6 @@ export interface AssistantOverrides { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; } diff --git a/src/api/types/AssistantOverridesCredentialsItem.ts b/src/api/types/AssistantOverridesCredentialsItem.ts index 5ef8d958..d0c4d478 100644 --- a/src/api/types/AssistantOverridesCredentialsItem.ts +++ b/src/api/types/AssistantOverridesCredentialsItem.ts @@ -34,6 +34,7 @@ export type AssistantOverridesCredentialsItem = | Vapi.AssistantOverridesCredentialsItem.RimeAi | Vapi.AssistantOverridesCredentialsItem.Runpod | Vapi.AssistantOverridesCredentialsItem.S3 + | Vapi.AssistantOverridesCredentialsItem.S3Compatible | Vapi.AssistantOverridesCredentialsItem.Supabase | Vapi.AssistantOverridesCredentialsItem.SmallestAi | Vapi.AssistantOverridesCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type AssistantOverridesCredentialsItem = | Vapi.AssistantOverridesCredentialsItem.Webhook | Vapi.AssistantOverridesCredentialsItem.CustomCredential | Vapi.AssistantOverridesCredentialsItem.Xai + | Vapi.AssistantOverridesCredentialsItem.Microsoft | Vapi.AssistantOverridesCredentialsItem.Neuphonic | Vapi.AssistantOverridesCredentialsItem.Hume | Vapi.AssistantOverridesCredentialsItem.Mistral | Vapi.AssistantOverridesCredentialsItem.Speechmatics | Vapi.AssistantOverridesCredentialsItem.Soniox - | Vapi.AssistantOverridesCredentialsItem.Trieve | Vapi.AssistantOverridesCredentialsItem.GoogleCalendarOauth2Client | Vapi.AssistantOverridesCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.AssistantOverridesCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace AssistantOverridesCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace AssistantOverridesCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace AssistantOverridesCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace AssistantOverridesCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.AssistantOverridesCredentialsItem._11Labs + | Vapi.AssistantOverridesCredentialsItem.Anthropic + | Vapi.AssistantOverridesCredentialsItem.AnthropicBedrock + | Vapi.AssistantOverridesCredentialsItem.Anyscale + | Vapi.AssistantOverridesCredentialsItem.AssemblyAi + | Vapi.AssistantOverridesCredentialsItem.AzureOpenai + | Vapi.AssistantOverridesCredentialsItem.Azure + | Vapi.AssistantOverridesCredentialsItem.ByoSipTrunk + | Vapi.AssistantOverridesCredentialsItem.Cartesia + | Vapi.AssistantOverridesCredentialsItem.Cerebras + | Vapi.AssistantOverridesCredentialsItem.Cloudflare + | Vapi.AssistantOverridesCredentialsItem.CustomLlm + | Vapi.AssistantOverridesCredentialsItem.Deepgram + | Vapi.AssistantOverridesCredentialsItem.Deepinfra + | Vapi.AssistantOverridesCredentialsItem.DeepSeek + | Vapi.AssistantOverridesCredentialsItem.Gcp + | Vapi.AssistantOverridesCredentialsItem.Gladia + | Vapi.AssistantOverridesCredentialsItem.Gohighlevel + | Vapi.AssistantOverridesCredentialsItem.Google + | Vapi.AssistantOverridesCredentialsItem.Groq + | Vapi.AssistantOverridesCredentialsItem.InflectionAi + | Vapi.AssistantOverridesCredentialsItem.Langfuse + | Vapi.AssistantOverridesCredentialsItem.Lmnt + | Vapi.AssistantOverridesCredentialsItem.Make + | Vapi.AssistantOverridesCredentialsItem.Openai + | Vapi.AssistantOverridesCredentialsItem.Openrouter + | Vapi.AssistantOverridesCredentialsItem.PerplexityAi + | Vapi.AssistantOverridesCredentialsItem.Playht + | Vapi.AssistantOverridesCredentialsItem.RimeAi + | Vapi.AssistantOverridesCredentialsItem.Runpod + | Vapi.AssistantOverridesCredentialsItem.S3 + | Vapi.AssistantOverridesCredentialsItem.S3Compatible + | Vapi.AssistantOverridesCredentialsItem.Supabase + | Vapi.AssistantOverridesCredentialsItem.SmallestAi + | Vapi.AssistantOverridesCredentialsItem.Tavus + | Vapi.AssistantOverridesCredentialsItem.TogetherAi + | Vapi.AssistantOverridesCredentialsItem.Twilio + | Vapi.AssistantOverridesCredentialsItem.Vonage + | Vapi.AssistantOverridesCredentialsItem.Webhook + | Vapi.AssistantOverridesCredentialsItem.CustomCredential + | Vapi.AssistantOverridesCredentialsItem.Xai + | Vapi.AssistantOverridesCredentialsItem.Microsoft + | Vapi.AssistantOverridesCredentialsItem.Neuphonic + | Vapi.AssistantOverridesCredentialsItem.Hume + | Vapi.AssistantOverridesCredentialsItem.Mistral + | Vapi.AssistantOverridesCredentialsItem.Speechmatics + | Vapi.AssistantOverridesCredentialsItem.Soniox + | Vapi.AssistantOverridesCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantOverridesCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantOverridesCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantOverridesCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantOverridesCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantOverridesCredentialsItem.Inworld + | Vapi.AssistantOverridesCredentialsItem.Minimax + | Vapi.AssistantOverridesCredentialsItem.Wellsaid + | Vapi.AssistantOverridesCredentialsItem.Email + | Vapi.AssistantOverridesCredentialsItem.SlackWebhook; } diff --git a/src/api/types/AssistantOverridesModel.ts b/src/api/types/AssistantOverridesModel.ts index 3cbc715f..94e0f8a1 100644 --- a/src/api/types/AssistantOverridesModel.ts +++ b/src/api/types/AssistantOverridesModel.ts @@ -21,7 +21,8 @@ export type AssistantOverridesModel = | Vapi.AssistantOverridesModel.Openrouter | Vapi.AssistantOverridesModel.PerplexityAi | Vapi.AssistantOverridesModel.TogetherAi - | Vapi.AssistantOverridesModel.Xai; + | Vapi.AssistantOverridesModel.Xai + | Vapi.AssistantOverridesModel.Vapi; export namespace AssistantOverridesModel { export interface Anthropic extends Vapi.AnthropicModel { @@ -87,4 +88,30 @@ export namespace AssistantOverridesModel { export interface Xai extends Vapi.XaiModel { provider: "xai"; } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.AssistantOverridesModel.Anthropic + | Vapi.AssistantOverridesModel.AnthropicBedrock + | Vapi.AssistantOverridesModel.Anyscale + | Vapi.AssistantOverridesModel.Cerebras + | Vapi.AssistantOverridesModel.CustomLlm + | Vapi.AssistantOverridesModel.Deepinfra + | Vapi.AssistantOverridesModel.DeepSeek + | Vapi.AssistantOverridesModel.Google + | Vapi.AssistantOverridesModel.Groq + | Vapi.AssistantOverridesModel.InflectionAi + | Vapi.AssistantOverridesModel.Minimax + | Vapi.AssistantOverridesModel.Openai + | Vapi.AssistantOverridesModel.Openrouter + | Vapi.AssistantOverridesModel.PerplexityAi + | Vapi.AssistantOverridesModel.TogetherAi + | Vapi.AssistantOverridesModel.Xai + | Vapi.AssistantOverridesModel.Vapi; } diff --git a/src/api/types/AssistantOverridesServerMessagesItem.ts b/src/api/types/AssistantOverridesServerMessagesItem.ts index f69e9467..b6d401f2 100644 --- a/src/api/types/AssistantOverridesServerMessagesItem.ts +++ b/src/api/types/AssistantOverridesServerMessagesItem.ts @@ -28,6 +28,7 @@ export const AssistantOverridesServerMessagesItem = { SessionDeleted: "session.deleted", CallDeleted: "call.deleted", CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", } as const; export type AssistantOverridesServerMessagesItem = (typeof AssistantOverridesServerMessagesItem)[keyof typeof AssistantOverridesServerMessagesItem]; diff --git a/src/api/types/AssistantOverridesToolsAppendItem.ts b/src/api/types/AssistantOverridesToolsAppendItem.ts index d6ece9df..ac56be7a 100644 --- a/src/api/types/AssistantOverridesToolsAppendItem.ts +++ b/src/api/types/AssistantOverridesToolsAppendItem.ts @@ -119,4 +119,29 @@ export namespace AssistantOverridesToolsAppendItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.AssistantOverridesToolsAppendItem.ApiRequest + | Vapi.AssistantOverridesToolsAppendItem.Bash + | Vapi.AssistantOverridesToolsAppendItem.Code + | Vapi.AssistantOverridesToolsAppendItem.Computer + | Vapi.AssistantOverridesToolsAppendItem.Dtmf + | Vapi.AssistantOverridesToolsAppendItem.EndCall + | Vapi.AssistantOverridesToolsAppendItem.Function + | Vapi.AssistantOverridesToolsAppendItem.GohighlevelCalendarAvailabilityCheck + | Vapi.AssistantOverridesToolsAppendItem.GohighlevelCalendarEventCreate + | Vapi.AssistantOverridesToolsAppendItem.GohighlevelContactCreate + | Vapi.AssistantOverridesToolsAppendItem.GohighlevelContactGet + | Vapi.AssistantOverridesToolsAppendItem.GoogleCalendarAvailabilityCheck + | Vapi.AssistantOverridesToolsAppendItem.GoogleCalendarEventCreate + | Vapi.AssistantOverridesToolsAppendItem.GoogleSheetsRowAppend + | Vapi.AssistantOverridesToolsAppendItem.Handoff + | Vapi.AssistantOverridesToolsAppendItem.Mcp + | Vapi.AssistantOverridesToolsAppendItem.Query + | Vapi.AssistantOverridesToolsAppendItem.SlackMessageSend + | Vapi.AssistantOverridesToolsAppendItem.Sms + | Vapi.AssistantOverridesToolsAppendItem.TextEditor + | Vapi.AssistantOverridesToolsAppendItem.TransferCall + | Vapi.AssistantOverridesToolsAppendItem.SipRequest + | Vapi.AssistantOverridesToolsAppendItem.Voicemail; } diff --git a/src/api/types/AssistantOverridesTranscriber.ts b/src/api/types/AssistantOverridesTranscriber.ts index e2cfc62f..6a1abbde 100644 --- a/src/api/types/AssistantOverridesTranscriber.ts +++ b/src/api/types/AssistantOverridesTranscriber.ts @@ -17,7 +17,9 @@ export type AssistantOverridesTranscriber = | Vapi.AssistantOverridesTranscriber.Talkscriber | Vapi.AssistantOverridesTranscriber.Openai | Vapi.AssistantOverridesTranscriber.Cartesia - | Vapi.AssistantOverridesTranscriber.Soniox; + | Vapi.AssistantOverridesTranscriber.Soniox + | Vapi.AssistantOverridesTranscriber.Xai + | Vapi.AssistantOverridesTranscriber.Vapi; export namespace AssistantOverridesTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -67,4 +69,12 @@ export namespace AssistantOverridesTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/AssistantOverridesVoice.ts b/src/api/types/AssistantOverridesVoice.ts index 36a78e9f..cc442137 100644 --- a/src/api/types/AssistantOverridesVoice.ts +++ b/src/api/types/AssistantOverridesVoice.ts @@ -23,7 +23,9 @@ export type AssistantOverridesVoice = | Vapi.AssistantOverridesVoice.Vapi | Vapi.AssistantOverridesVoice.Sesame | Vapi.AssistantOverridesVoice.Inworld - | Vapi.AssistantOverridesVoice.Minimax; + | Vapi.AssistantOverridesVoice.Minimax + | Vapi.AssistantOverridesVoice.Xai + | Vapi.AssistantOverridesVoice.Microsoft; export namespace AssistantOverridesVoice { export interface Azure extends Vapi.AzureVoice { @@ -97,4 +99,12 @@ export namespace AssistantOverridesVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/AssistantPinnedConflictResponseDto.ts b/src/api/types/AssistantPinnedConflictResponseDto.ts new file mode 100644 index 00000000..adfbe6e7 --- /dev/null +++ b/src/api/types/AssistantPinnedConflictResponseDto.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface AssistantPinnedConflictResponseDto { + error: Vapi.AssistantPinnedConflictResponseDtoError; + /** Human-readable reason the parent-assistant delete was rejected. */ + message: string; +} diff --git a/src/api/types/AssistantPinnedConflictResponseDtoError.ts b/src/api/types/AssistantPinnedConflictResponseDtoError.ts new file mode 100644 index 00000000..a5a93deb --- /dev/null +++ b/src/api/types/AssistantPinnedConflictResponseDtoError.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantPinnedConflictResponseDtoError = { + AssistantPinned: "assistant_pinned", +} as const; +export type AssistantPinnedConflictResponseDtoError = + (typeof AssistantPinnedConflictResponseDtoError)[keyof typeof AssistantPinnedConflictResponseDtoError]; diff --git a/src/api/types/AssistantServerMessagesItem.ts b/src/api/types/AssistantServerMessagesItem.ts index 8037a807..f83b752a 100644 --- a/src/api/types/AssistantServerMessagesItem.ts +++ b/src/api/types/AssistantServerMessagesItem.ts @@ -28,6 +28,7 @@ export const AssistantServerMessagesItem = { SessionDeleted: "session.deleted", CallDeleted: "call.deleted", CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", } as const; export type AssistantServerMessagesItem = (typeof AssistantServerMessagesItem)[keyof typeof AssistantServerMessagesItem]; diff --git a/src/api/types/AssistantTranscriber.ts b/src/api/types/AssistantTranscriber.ts index 893bde55..4dff57c5 100644 --- a/src/api/types/AssistantTranscriber.ts +++ b/src/api/types/AssistantTranscriber.ts @@ -17,7 +17,9 @@ export type AssistantTranscriber = | Vapi.AssistantTranscriber.Talkscriber | Vapi.AssistantTranscriber.Openai | Vapi.AssistantTranscriber.Cartesia - | Vapi.AssistantTranscriber.Soniox; + | Vapi.AssistantTranscriber.Soniox + | Vapi.AssistantTranscriber.Xai + | Vapi.AssistantTranscriber.Vapi; export namespace AssistantTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -67,4 +69,12 @@ export namespace AssistantTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/AssistantVersion.ts b/src/api/types/AssistantVersion.ts new file mode 100644 index 00000000..c1d1cb9d --- /dev/null +++ b/src/api/types/AssistantVersion.ts @@ -0,0 +1,178 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface AssistantVersion { + /** These are the options for the assistant's transcriber. */ + transcriber?: Vapi.AssistantVersionTranscriber | undefined; + /** These are the options for the assistant's LLM. */ + model?: Vapi.AssistantVersionModel | undefined; + /** These are the options for the assistant's voice. */ + voice?: Vapi.AssistantVersionVoice | undefined; + /** + * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). + * + * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. + */ + firstMessage?: string | undefined; + firstMessageInterruptionsEnabled?: boolean | undefined; + /** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.AssistantVersionFirstMessageMode | undefined; + /** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ + voicemailDetection?: Vapi.AssistantVersionVoicemailDetection | undefined; + /** These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema. */ + clientMessages?: Vapi.AssistantVersionClientMessagesItem[] | undefined; + /** These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema. */ + serverMessages?: Vapi.AssistantVersionServerMessagesItem[] | undefined; + /** + * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. + * + * @default 600 (10 minutes) + */ + maxDurationSeconds?: number | undefined; + /** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ + backgroundSound?: Vapi.AssistantVersionBackgroundSound | undefined; + /** + * This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. + * + * @default false + */ + modelOutputInMessagesEnabled?: boolean | undefined; + /** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */ + transportConfigurations?: Vapi.TransportConfigurationTwilio[] | undefined; + /** + * This is the plan for observability of assistant's calls. + * + * Currently, only Langfuse is supported. + */ + observabilityPlan?: Vapi.LangfuseObservabilityPlan | undefined; + /** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */ + credentials?: Vapi.AssistantVersionCredentialsItem[] | undefined; + /** This is a set of actions that will be performed on certain events. */ + hooks?: Vapi.AssistantVersionHooksItem[] | undefined; + /** Optional human-readable label for this version. Pass `null` to clear. */ + versionName?: (string | null) | undefined; + /** Optional description for this version. Pass `null` to clear. */ + versionDescription?: (string | null) | undefined; + /** This is the unique identifier for the version row. */ + id: string; + /** This is the unique identifier for the org that owns this version. */ + orgId: string; + /** This is the unique identifier for the assistant this version was snapshotted from. */ + assistantId: string; + /** + * This is the public monotonic version label, e.g. "v1". + * System-owned and incremented per assistant; never user-supplied. + */ + version: string; + /** This is the SHA-256 hex of the snapshotted content used for no-op detection. */ + configHash: string; + /** This is the prior version label (vN-1). Null on v1 or for branch roots. */ + parentVersion?: (string | null) | undefined; + /** The version this version was restored from. Null when it was not restored. */ + restoredFromVersion?: (string | null) | undefined; + /** This is the actor that wrote this version. Email when created via JWT, null when created via API. */ + createdBy?: (string | null) | undefined; + /** This is the soft-delete timestamp. Null when active. */ + deletedAt?: (string | null) | undefined; + /** This is the ISO 8601 date-time string of when the version was created. */ + createdAt: string; + /** + * This is the name of the assistant. + * + * This is required when you want to transfer between assistants in a call. + */ + name?: string | undefined; + /** + * This is the message that the assistant will say if the call is forwarded to voicemail. + * + * If unspecified, it will hang up. + */ + voicemailMessage?: string | undefined; + /** + * This is the message that the assistant will say if it ends the call. + * + * If unspecified, it will hang up without saying anything. + */ + endCallMessage?: string | undefined; + /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ + endCallPhrases?: string[] | undefined; + compliancePlan?: Vapi.CompliancePlan | undefined; + /** This is for metadata you want to store on the assistant. */ + metadata?: Record | undefined; + /** + * This enables filtering of noise and background speech while the user is talking. + * + * Features: + * - Smart denoising using Krisp + * - Fourier denoising + * + * Smart denoising can be combined with or used independently of Fourier denoising. + * + * Order of precedence: + * - Smart denoising + * - Fourier denoising + */ + backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan | undefined; + /** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */ + analysisPlan?: Vapi.AnalysisPlan | undefined; + /** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */ + artifactPlan?: Vapi.ArtifactPlan | undefined; + /** + * This is the plan for when the assistant should start talking. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to start talking after the customer is done speaking. + * - The assistant is too fast to start talking after the customer is done speaking. + * - The assistant is so fast that it's actually interrupting the customer. + */ + startSpeakingPlan?: Vapi.StartSpeakingPlan | undefined; + /** + * This is the plan for when assistant should stop talking on customer interruption. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to recognize customer's interruption. + * - The assistant is too fast to recognize customer's interruption. + * - The assistant is getting interrupted by phrases that are just acknowledgments. + * - The assistant is getting interrupted by background noises. + * - The assistant is not properly stopping -- it starts talking right after getting interrupted. + */ + stopSpeakingPlan?: Vapi.StopSpeakingPlan | undefined; + /** + * This is the plan for real-time monitoring of the assistant's calls. + * + * Usage: + * - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. + * - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`. + * - To attach monitors to the assistant, set `monitorPlan.monitorIds` to the set of monitor ids. + */ + monitorPlan?: Vapi.MonitorPlan | undefined; + /** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */ + credentialIds?: string[] | undefined; + /** + * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. + * + * The order of precedence is: + * + * 1. assistant.server.url + * 2. phoneNumber.serverUrl + * 3. org.serverUrl + */ + server?: Vapi.Server | undefined; + keypadInputPlan?: Vapi.KeypadInputPlan | undefined; +} diff --git a/src/api/types/AssistantVersionBackgroundSound.ts b/src/api/types/AssistantVersionBackgroundSound.ts new file mode 100644 index 00000000..4cc995a1 --- /dev/null +++ b/src/api/types/AssistantVersionBackgroundSound.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ +export type AssistantVersionBackgroundSound = Vapi.AssistantVersionBackgroundSoundZero | string; diff --git a/src/api/types/AssistantVersionBackgroundSoundZero.ts b/src/api/types/AssistantVersionBackgroundSoundZero.ts new file mode 100644 index 00000000..f7182d9a --- /dev/null +++ b/src/api/types/AssistantVersionBackgroundSoundZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantVersionBackgroundSoundZero = { + Off: "off", + Office: "office", +} as const; +export type AssistantVersionBackgroundSoundZero = + (typeof AssistantVersionBackgroundSoundZero)[keyof typeof AssistantVersionBackgroundSoundZero]; diff --git a/src/api/types/AssistantVersionClientMessagesItem.ts b/src/api/types/AssistantVersionClientMessagesItem.ts new file mode 100644 index 00000000..645f291f --- /dev/null +++ b/src/api/types/AssistantVersionClientMessagesItem.ts @@ -0,0 +1,25 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantVersionClientMessagesItem = { + ConversationUpdate: "conversation-update", + AssistantSpeechStarted: "assistant.speechStarted", + FunctionCall: "function-call", + FunctionCallResult: "function-call-result", + Hang: "hang", + LanguageChanged: "language-changed", + Metadata: "metadata", + ModelOutput: "model-output", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + ToolCalls: "tool-calls", + ToolCallsResult: "tool-calls-result", + ToolCompleted: "tool.completed", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + WorkflowNodeStarted: "workflow.node.started", + AssistantStarted: "assistant.started", +} as const; +export type AssistantVersionClientMessagesItem = + (typeof AssistantVersionClientMessagesItem)[keyof typeof AssistantVersionClientMessagesItem]; diff --git a/src/api/types/AssistantVersionCredentialsItem.ts b/src/api/types/AssistantVersionCredentialsItem.ts new file mode 100644 index 00000000..f30dcc78 --- /dev/null +++ b/src/api/types/AssistantVersionCredentialsItem.ts @@ -0,0 +1,352 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type AssistantVersionCredentialsItem = + | Vapi.AssistantVersionCredentialsItem._11Labs + | Vapi.AssistantVersionCredentialsItem.Anthropic + | Vapi.AssistantVersionCredentialsItem.AnthropicBedrock + | Vapi.AssistantVersionCredentialsItem.Anyscale + | Vapi.AssistantVersionCredentialsItem.AssemblyAi + | Vapi.AssistantVersionCredentialsItem.AzureOpenai + | Vapi.AssistantVersionCredentialsItem.Azure + | Vapi.AssistantVersionCredentialsItem.ByoSipTrunk + | Vapi.AssistantVersionCredentialsItem.Cartesia + | Vapi.AssistantVersionCredentialsItem.Cerebras + | Vapi.AssistantVersionCredentialsItem.Cloudflare + | Vapi.AssistantVersionCredentialsItem.CustomLlm + | Vapi.AssistantVersionCredentialsItem.Deepgram + | Vapi.AssistantVersionCredentialsItem.Deepinfra + | Vapi.AssistantVersionCredentialsItem.DeepSeek + | Vapi.AssistantVersionCredentialsItem.Gcp + | Vapi.AssistantVersionCredentialsItem.Gladia + | Vapi.AssistantVersionCredentialsItem.Gohighlevel + | Vapi.AssistantVersionCredentialsItem.Google + | Vapi.AssistantVersionCredentialsItem.Groq + | Vapi.AssistantVersionCredentialsItem.InflectionAi + | Vapi.AssistantVersionCredentialsItem.Langfuse + | Vapi.AssistantVersionCredentialsItem.Lmnt + | Vapi.AssistantVersionCredentialsItem.Make + | Vapi.AssistantVersionCredentialsItem.Openai + | Vapi.AssistantVersionCredentialsItem.Openrouter + | Vapi.AssistantVersionCredentialsItem.PerplexityAi + | Vapi.AssistantVersionCredentialsItem.Playht + | Vapi.AssistantVersionCredentialsItem.RimeAi + | Vapi.AssistantVersionCredentialsItem.Runpod + | Vapi.AssistantVersionCredentialsItem.S3 + | Vapi.AssistantVersionCredentialsItem.S3Compatible + | Vapi.AssistantVersionCredentialsItem.Supabase + | Vapi.AssistantVersionCredentialsItem.SmallestAi + | Vapi.AssistantVersionCredentialsItem.Tavus + | Vapi.AssistantVersionCredentialsItem.TogetherAi + | Vapi.AssistantVersionCredentialsItem.Twilio + | Vapi.AssistantVersionCredentialsItem.Vonage + | Vapi.AssistantVersionCredentialsItem.Webhook + | Vapi.AssistantVersionCredentialsItem.CustomCredential + | Vapi.AssistantVersionCredentialsItem.Xai + | Vapi.AssistantVersionCredentialsItem.Microsoft + | Vapi.AssistantVersionCredentialsItem.Neuphonic + | Vapi.AssistantVersionCredentialsItem.Hume + | Vapi.AssistantVersionCredentialsItem.Mistral + | Vapi.AssistantVersionCredentialsItem.Speechmatics + | Vapi.AssistantVersionCredentialsItem.Soniox + | Vapi.AssistantVersionCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantVersionCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.Inworld + | Vapi.AssistantVersionCredentialsItem.Minimax + | Vapi.AssistantVersionCredentialsItem.Wellsaid + | Vapi.AssistantVersionCredentialsItem.Email + | Vapi.AssistantVersionCredentialsItem.SlackWebhook; + +export namespace AssistantVersionCredentialsItem { + export interface _11Labs extends Vapi.CreateElevenLabsCredentialDto { + provider: "11labs"; + } + + export interface Anthropic extends Vapi.CreateAnthropicCredentialDto { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.CreateAnthropicBedrockCredentialDto { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.CreateAnyscaleCredentialDto { + provider: "anyscale"; + } + + export interface AssemblyAi extends Vapi.CreateAssemblyAiCredentialDto { + provider: "assembly-ai"; + } + + export interface AzureOpenai extends Vapi.CreateAzureOpenAiCredentialDto { + provider: "azure-openai"; + } + + export interface Azure extends Vapi.CreateAzureCredentialDto { + provider: "azure"; + } + + export interface ByoSipTrunk extends Vapi.CreateByoSipTrunkCredentialDto { + provider: "byo-sip-trunk"; + } + + export interface Cartesia extends Vapi.CreateCartesiaCredentialDto { + provider: "cartesia"; + } + + export interface Cerebras extends Vapi.CreateCerebrasCredentialDto { + provider: "cerebras"; + } + + export interface Cloudflare extends Vapi.CreateCloudflareCredentialDto { + provider: "cloudflare"; + } + + export interface CustomLlm extends Vapi.CreateCustomLlmCredentialDto { + provider: "custom-llm"; + } + + export interface Deepgram extends Vapi.CreateDeepgramCredentialDto { + provider: "deepgram"; + } + + export interface Deepinfra extends Vapi.CreateDeepInfraCredentialDto { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.CreateDeepSeekCredentialDto { + provider: "deep-seek"; + } + + export interface Gcp extends Vapi.CreateGcpCredentialDto { + provider: "gcp"; + } + + export interface Gladia extends Vapi.CreateGladiaCredentialDto { + provider: "gladia"; + } + + export interface Gohighlevel extends Vapi.CreateGoHighLevelCredentialDto { + provider: "gohighlevel"; + } + + export interface Google extends Vapi.CreateGoogleCredentialDto { + provider: "google"; + } + + export interface Groq extends Vapi.CreateGroqCredentialDto { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.CreateInflectionAiCredentialDto { + provider: "inflection-ai"; + } + + export interface Langfuse extends Vapi.CreateLangfuseCredentialDto { + provider: "langfuse"; + } + + export interface Lmnt extends Vapi.CreateLmntCredentialDto { + provider: "lmnt"; + } + + export interface Make extends Vapi.CreateMakeCredentialDto { + provider: "make"; + } + + export interface Openai extends Vapi.CreateOpenAiCredentialDto { + provider: "openai"; + } + + export interface Openrouter extends Vapi.CreateOpenRouterCredentialDto { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.CreatePerplexityAiCredentialDto { + provider: "perplexity-ai"; + } + + export interface Playht extends Vapi.CreatePlayHtCredentialDto { + provider: "playht"; + } + + export interface RimeAi extends Vapi.CreateRimeAiCredentialDto { + provider: "rime-ai"; + } + + export interface Runpod extends Vapi.CreateRunpodCredentialDto { + provider: "runpod"; + } + + export interface S3 extends Vapi.CreateS3CredentialDto { + provider: "s3"; + } + + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { + provider: "supabase"; + } + + export interface SmallestAi extends Vapi.CreateSmallestAiCredentialDto { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.CreateTavusCredentialDto { + provider: "tavus"; + } + + export interface TogetherAi extends Vapi.CreateTogetherAiCredentialDto { + provider: "together-ai"; + } + + export interface Twilio extends Vapi.CreateTwilioCredentialDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonageCredentialDto { + provider: "vonage"; + } + + export interface Webhook extends Vapi.CreateWebhookCredentialDto { + provider: "webhook"; + } + + export interface CustomCredential extends Vapi.CreateCustomCredentialDto { + provider: "custom-credential"; + } + + export interface Xai extends Vapi.CreateXAiCredentialDto { + provider: "xai"; + } + + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { + provider: "neuphonic"; + } + + export interface Hume extends Vapi.CreateHumeCredentialDto { + provider: "hume"; + } + + export interface Mistral extends Vapi.CreateMistralCredentialDto { + provider: "mistral"; + } + + export interface Speechmatics extends Vapi.CreateSpeechmaticsCredentialDto { + provider: "speechmatics"; + } + + export interface Soniox extends Vapi.CreateSonioxCredentialDto { + provider: "soniox"; + } + + export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { + provider: "google.calendar.oauth2-client"; + } + + export interface GoogleCalendarOauth2Authorization + extends Vapi.CreateGoogleCalendarOAuth2AuthorizationCredentialDto { + provider: "google.calendar.oauth2-authorization"; + } + + export interface GoogleSheetsOauth2Authorization extends Vapi.CreateGoogleSheetsOAuth2AuthorizationCredentialDto { + provider: "google.sheets.oauth2-authorization"; + } + + export interface SlackOauth2Authorization extends Vapi.CreateSlackOAuth2AuthorizationCredentialDto { + provider: "slack.oauth2-authorization"; + } + + export interface GhlOauth2Authorization extends Vapi.CreateGoHighLevelMcpCredentialDto { + provider: "ghl.oauth2-authorization"; + } + + export interface Inworld extends Vapi.CreateInworldCredentialDto { + provider: "inworld"; + } + + export interface Minimax extends Vapi.CreateMinimaxCredentialDto { + provider: "minimax"; + } + + export interface Wellsaid extends Vapi.CreateWellSaidCredentialDto { + provider: "wellsaid"; + } + + export interface Email extends Vapi.CreateEmailCredentialDto { + provider: "email"; + } + + export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { + provider: "slack-webhook"; + } + + export type Response = + | Vapi.AssistantVersionCredentialsItem._11Labs + | Vapi.AssistantVersionCredentialsItem.Anthropic + | Vapi.AssistantVersionCredentialsItem.AnthropicBedrock + | Vapi.AssistantVersionCredentialsItem.Anyscale + | Vapi.AssistantVersionCredentialsItem.AssemblyAi + | Vapi.AssistantVersionCredentialsItem.AzureOpenai + | Vapi.AssistantVersionCredentialsItem.Azure + | Vapi.AssistantVersionCredentialsItem.ByoSipTrunk + | Vapi.AssistantVersionCredentialsItem.Cartesia + | Vapi.AssistantVersionCredentialsItem.Cerebras + | Vapi.AssistantVersionCredentialsItem.Cloudflare + | Vapi.AssistantVersionCredentialsItem.CustomLlm + | Vapi.AssistantVersionCredentialsItem.Deepgram + | Vapi.AssistantVersionCredentialsItem.Deepinfra + | Vapi.AssistantVersionCredentialsItem.DeepSeek + | Vapi.AssistantVersionCredentialsItem.Gcp + | Vapi.AssistantVersionCredentialsItem.Gladia + | Vapi.AssistantVersionCredentialsItem.Gohighlevel + | Vapi.AssistantVersionCredentialsItem.Google + | Vapi.AssistantVersionCredentialsItem.Groq + | Vapi.AssistantVersionCredentialsItem.InflectionAi + | Vapi.AssistantVersionCredentialsItem.Langfuse + | Vapi.AssistantVersionCredentialsItem.Lmnt + | Vapi.AssistantVersionCredentialsItem.Make + | Vapi.AssistantVersionCredentialsItem.Openai + | Vapi.AssistantVersionCredentialsItem.Openrouter + | Vapi.AssistantVersionCredentialsItem.PerplexityAi + | Vapi.AssistantVersionCredentialsItem.Playht + | Vapi.AssistantVersionCredentialsItem.RimeAi + | Vapi.AssistantVersionCredentialsItem.Runpod + | Vapi.AssistantVersionCredentialsItem.S3 + | Vapi.AssistantVersionCredentialsItem.S3Compatible + | Vapi.AssistantVersionCredentialsItem.Supabase + | Vapi.AssistantVersionCredentialsItem.SmallestAi + | Vapi.AssistantVersionCredentialsItem.Tavus + | Vapi.AssistantVersionCredentialsItem.TogetherAi + | Vapi.AssistantVersionCredentialsItem.Twilio + | Vapi.AssistantVersionCredentialsItem.Vonage + | Vapi.AssistantVersionCredentialsItem.Webhook + | Vapi.AssistantVersionCredentialsItem.CustomCredential + | Vapi.AssistantVersionCredentialsItem.Xai + | Vapi.AssistantVersionCredentialsItem.Microsoft + | Vapi.AssistantVersionCredentialsItem.Neuphonic + | Vapi.AssistantVersionCredentialsItem.Hume + | Vapi.AssistantVersionCredentialsItem.Mistral + | Vapi.AssistantVersionCredentialsItem.Speechmatics + | Vapi.AssistantVersionCredentialsItem.Soniox + | Vapi.AssistantVersionCredentialsItem.GoogleCalendarOauth2Client + | Vapi.AssistantVersionCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.SlackOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.GhlOauth2Authorization + | Vapi.AssistantVersionCredentialsItem.Inworld + | Vapi.AssistantVersionCredentialsItem.Minimax + | Vapi.AssistantVersionCredentialsItem.Wellsaid + | Vapi.AssistantVersionCredentialsItem.Email + | Vapi.AssistantVersionCredentialsItem.SlackWebhook; +} diff --git a/src/api/types/AssistantVersionFirstMessageMode.ts b/src/api/types/AssistantVersionFirstMessageMode.ts new file mode 100644 index 00000000..4f1aa565 --- /dev/null +++ b/src/api/types/AssistantVersionFirstMessageMode.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ +export const AssistantVersionFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantSpeaksFirstWithModelGeneratedMessage: "assistant-speaks-first-with-model-generated-message", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type AssistantVersionFirstMessageMode = + (typeof AssistantVersionFirstMessageMode)[keyof typeof AssistantVersionFirstMessageMode]; diff --git a/src/api/types/AssistantVersionHooksItem.ts b/src/api/types/AssistantVersionHooksItem.ts new file mode 100644 index 00000000..4faa0028 --- /dev/null +++ b/src/api/types/AssistantVersionHooksItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type AssistantVersionHooksItem = + | Vapi.CallHookCallEnding + | Vapi.CallHookAssistantSpeechInterrupted + | Vapi.CallHookCustomerSpeechInterrupted + | Vapi.CallHookCustomerSpeechTimeout + | Vapi.SessionCreatedHook; diff --git a/src/api/types/AssistantVersionModel.ts b/src/api/types/AssistantVersionModel.ts new file mode 100644 index 00000000..ce4ad547 --- /dev/null +++ b/src/api/types/AssistantVersionModel.ts @@ -0,0 +1,117 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's LLM. + */ +export type AssistantVersionModel = + | Vapi.AssistantVersionModel.Anthropic + | Vapi.AssistantVersionModel.AnthropicBedrock + | Vapi.AssistantVersionModel.Anyscale + | Vapi.AssistantVersionModel.Cerebras + | Vapi.AssistantVersionModel.CustomLlm + | Vapi.AssistantVersionModel.Deepinfra + | Vapi.AssistantVersionModel.DeepSeek + | Vapi.AssistantVersionModel.Google + | Vapi.AssistantVersionModel.Groq + | Vapi.AssistantVersionModel.InflectionAi + | Vapi.AssistantVersionModel.Minimax + | Vapi.AssistantVersionModel.Openai + | Vapi.AssistantVersionModel.Openrouter + | Vapi.AssistantVersionModel.PerplexityAi + | Vapi.AssistantVersionModel.TogetherAi + | Vapi.AssistantVersionModel.Xai + | Vapi.AssistantVersionModel.Vapi; + +export namespace AssistantVersionModel { + export interface Anthropic extends Vapi.AnthropicModel { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.AnthropicBedrockModel { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.AnyscaleModel { + provider: "anyscale"; + } + + export interface Cerebras extends Vapi.CerebrasModel { + provider: "cerebras"; + } + + export interface CustomLlm extends Vapi.CustomLlmModel { + provider: "custom-llm"; + } + + export interface Deepinfra extends Vapi.DeepInfraModel { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.DeepSeekModel { + provider: "deep-seek"; + } + + export interface Google extends Vapi.GoogleModel { + provider: "google"; + } + + export interface Groq extends Vapi.GroqModel { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.InflectionAiModel { + provider: "inflection-ai"; + } + + export interface Minimax extends Vapi.MinimaxLlmModel { + provider: "minimax"; + } + + export interface Openai extends Vapi.OpenAiModel { + provider: "openai"; + } + + export interface Openrouter extends Vapi.OpenRouterModel { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.PerplexityAiModel { + provider: "perplexity-ai"; + } + + export interface TogetherAi extends Vapi.TogetherAiModel { + provider: "together-ai"; + } + + export interface Xai extends Vapi.XaiModel { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.AssistantVersionModel.Anthropic + | Vapi.AssistantVersionModel.AnthropicBedrock + | Vapi.AssistantVersionModel.Anyscale + | Vapi.AssistantVersionModel.Cerebras + | Vapi.AssistantVersionModel.CustomLlm + | Vapi.AssistantVersionModel.Deepinfra + | Vapi.AssistantVersionModel.DeepSeek + | Vapi.AssistantVersionModel.Google + | Vapi.AssistantVersionModel.Groq + | Vapi.AssistantVersionModel.InflectionAi + | Vapi.AssistantVersionModel.Minimax + | Vapi.AssistantVersionModel.Openai + | Vapi.AssistantVersionModel.Openrouter + | Vapi.AssistantVersionModel.PerplexityAi + | Vapi.AssistantVersionModel.TogetherAi + | Vapi.AssistantVersionModel.Xai + | Vapi.AssistantVersionModel.Vapi; +} diff --git a/src/api/types/AssistantVersionPaginatedMetadata.ts b/src/api/types/AssistantVersionPaginatedMetadata.ts new file mode 100644 index 00000000..06b9e65b --- /dev/null +++ b/src/api/types/AssistantVersionPaginatedMetadata.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface AssistantVersionPaginatedMetadata { + nextCursor?: (string | null) | undefined; + hasNextPage: boolean; + limit: number; +} diff --git a/src/api/types/AssistantVersionPaginatedResponse.ts b/src/api/types/AssistantVersionPaginatedResponse.ts index 16d25a71..1e1a2515 100644 --- a/src/api/types/AssistantVersionPaginatedResponse.ts +++ b/src/api/types/AssistantVersionPaginatedResponse.ts @@ -3,7 +3,6 @@ import type * as Vapi from "../index.js"; export interface AssistantVersionPaginatedResponse { - results: unknown[]; - metadata: Vapi.PaginationMeta; - nextPageState?: string | undefined; + results: Vapi.AssistantVersion[]; + metadata: Vapi.AssistantVersionPaginatedMetadata; } diff --git a/src/api/types/AssistantVersionServerMessagesItem.ts b/src/api/types/AssistantVersionServerMessagesItem.ts new file mode 100644 index 00000000..6cc9de1b --- /dev/null +++ b/src/api/types/AssistantVersionServerMessagesItem.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantVersionServerMessagesItem = { + AssistantStarted: "assistant.started", + AssistantSpeechStarted: "assistant.speechStarted", + ConversationUpdate: "conversation-update", + EndOfCallReport: "end-of-call-report", + FunctionCall: "function-call", + Hang: "hang", + LanguageChanged: "language-changed", + LanguageChangeDetected: "language-change-detected", + ModelOutput: "model-output", + PhoneCallControl: "phone-call-control", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + TranscriptTranscriptTypeFinal: 'transcript[transcriptType="final"]', + ToolCalls: "tool-calls", + TransferDestinationRequest: "transfer-destination-request", + HandoffDestinationRequest: "handoff-destination-request", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + ChatCreated: "chat.created", + ChatDeleted: "chat.deleted", + SessionCreated: "session.created", + SessionUpdated: "session.updated", + SessionDeleted: "session.deleted", + CallDeleted: "call.deleted", + CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", +} as const; +export type AssistantVersionServerMessagesItem = + (typeof AssistantVersionServerMessagesItem)[keyof typeof AssistantVersionServerMessagesItem]; diff --git a/src/api/types/AssistantVersionTranscriber.ts b/src/api/types/AssistantVersionTranscriber.ts new file mode 100644 index 00000000..9558afb2 --- /dev/null +++ b/src/api/types/AssistantVersionTranscriber.ts @@ -0,0 +1,80 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's transcriber. + */ +export type AssistantVersionTranscriber = + | Vapi.AssistantVersionTranscriber.AssemblyAi + | Vapi.AssistantVersionTranscriber.Azure + | Vapi.AssistantVersionTranscriber.CustomTranscriber + | Vapi.AssistantVersionTranscriber.Deepgram + | Vapi.AssistantVersionTranscriber._11Labs + | Vapi.AssistantVersionTranscriber.Gladia + | Vapi.AssistantVersionTranscriber.Google + | Vapi.AssistantVersionTranscriber.Speechmatics + | Vapi.AssistantVersionTranscriber.Talkscriber + | Vapi.AssistantVersionTranscriber.Openai + | Vapi.AssistantVersionTranscriber.Cartesia + | Vapi.AssistantVersionTranscriber.Soniox + | Vapi.AssistantVersionTranscriber.Xai + | Vapi.AssistantVersionTranscriber.Vapi; + +export namespace AssistantVersionTranscriber { + export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { + provider: "assembly-ai"; + } + + export interface Azure extends Vapi.AzureSpeechTranscriber { + provider: "azure"; + } + + export interface CustomTranscriber extends Vapi.CustomTranscriber { + provider: "custom-transcriber"; + } + + export interface Deepgram extends Vapi.DeepgramTranscriber { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsTranscriber { + provider: "11labs"; + } + + export interface Gladia extends Vapi.GladiaTranscriber { + provider: "gladia"; + } + + export interface Google extends Vapi.GoogleTranscriber { + provider: "google"; + } + + export interface Speechmatics extends Vapi.SpeechmaticsTranscriber { + provider: "speechmatics"; + } + + export interface Talkscriber extends Vapi.TalkscriberTranscriber { + provider: "talkscriber"; + } + + export interface Openai extends Vapi.OpenAiTranscriber { + provider: "openai"; + } + + export interface Cartesia extends Vapi.CartesiaTranscriber { + provider: "cartesia"; + } + + export interface Soniox extends Vapi.SonioxTranscriber { + provider: "soniox"; + } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } +} diff --git a/src/api/types/AssistantVersionVoice.ts b/src/api/types/AssistantVersionVoice.ts new file mode 100644 index 00000000..be56debb --- /dev/null +++ b/src/api/types/AssistantVersionVoice.ts @@ -0,0 +1,110 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's voice. + */ +export type AssistantVersionVoice = + | Vapi.AssistantVersionVoice.Azure + | Vapi.AssistantVersionVoice.Cartesia + | Vapi.AssistantVersionVoice.CustomVoice + | Vapi.AssistantVersionVoice.Deepgram + | Vapi.AssistantVersionVoice._11Labs + | Vapi.AssistantVersionVoice.Hume + | Vapi.AssistantVersionVoice.Lmnt + | Vapi.AssistantVersionVoice.Neuphonic + | Vapi.AssistantVersionVoice.Openai + | Vapi.AssistantVersionVoice.Playht + | Vapi.AssistantVersionVoice.Wellsaid + | Vapi.AssistantVersionVoice.RimeAi + | Vapi.AssistantVersionVoice.SmallestAi + | Vapi.AssistantVersionVoice.Tavus + | Vapi.AssistantVersionVoice.Vapi + | Vapi.AssistantVersionVoice.Sesame + | Vapi.AssistantVersionVoice.Inworld + | Vapi.AssistantVersionVoice.Minimax + | Vapi.AssistantVersionVoice.Xai + | Vapi.AssistantVersionVoice.Microsoft; + +export namespace AssistantVersionVoice { + export interface Azure extends Vapi.AzureVoice { + provider: "azure"; + } + + export interface Cartesia extends Vapi.CartesiaVoice { + provider: "cartesia"; + } + + export interface CustomVoice extends Vapi.CustomVoice { + provider: "custom-voice"; + } + + export interface Deepgram extends Vapi.DeepgramVoice { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsVoice { + provider: "11labs"; + } + + export interface Hume extends Vapi.HumeVoice { + provider: "hume"; + } + + export interface Lmnt extends Vapi.LmntVoice { + provider: "lmnt"; + } + + export interface Neuphonic extends Vapi.NeuphonicVoice { + provider: "neuphonic"; + } + + export interface Openai extends Vapi.OpenAiVoice { + provider: "openai"; + } + + export interface Playht extends Vapi.PlayHtVoice { + provider: "playht"; + } + + export interface Wellsaid extends Vapi.WellSaidVoice { + provider: "wellsaid"; + } + + export interface RimeAi extends Vapi.RimeAiVoice { + provider: "rime-ai"; + } + + export interface SmallestAi extends Vapi.SmallestAiVoice { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.TavusVoice { + provider: "tavus"; + } + + export interface Vapi extends Vapi.VapiVoice { + provider: "vapi"; + } + + export interface Sesame extends Vapi.SesameVoice { + provider: "sesame"; + } + + export interface Inworld extends Vapi.InworldVoice { + provider: "inworld"; + } + + export interface Minimax extends Vapi.MinimaxVoice { + provider: "minimax"; + } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } +} diff --git a/src/api/types/AssistantVersionVoicemailDetection.ts b/src/api/types/AssistantVersionVoicemailDetection.ts new file mode 100644 index 00000000..fdeb931a --- /dev/null +++ b/src/api/types/AssistantVersionVoicemailDetection.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ +export type AssistantVersionVoicemailDetection = + | Vapi.AssistantVersionVoicemailDetectionZero + | Vapi.GoogleVoicemailDetectionPlan + | Vapi.OpenAiVoicemailDetectionPlan + | Vapi.TwilioVoicemailDetectionPlan + | Vapi.VapiVoicemailDetectionPlan; diff --git a/src/api/types/AssistantVersionVoicemailDetectionZero.ts b/src/api/types/AssistantVersionVoicemailDetectionZero.ts new file mode 100644 index 00000000..587729ed --- /dev/null +++ b/src/api/types/AssistantVersionVoicemailDetectionZero.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const AssistantVersionVoicemailDetectionZero = { + Off: "off", +} as const; +export type AssistantVersionVoicemailDetectionZero = + (typeof AssistantVersionVoicemailDetectionZero)[keyof typeof AssistantVersionVoicemailDetectionZero]; diff --git a/src/api/types/AssistantVoice.ts b/src/api/types/AssistantVoice.ts index 33b47cbc..7f7dd28c 100644 --- a/src/api/types/AssistantVoice.ts +++ b/src/api/types/AssistantVoice.ts @@ -23,7 +23,9 @@ export type AssistantVoice = | Vapi.AssistantVoice.Vapi | Vapi.AssistantVoice.Sesame | Vapi.AssistantVoice.Inworld - | Vapi.AssistantVoice.Minimax; + | Vapi.AssistantVoice.Minimax + | Vapi.AssistantVoice.Xai + | Vapi.AssistantVoice.Microsoft; export namespace AssistantVoice { export interface Azure extends Vapi.AzureVoice { @@ -97,4 +99,12 @@ export namespace AssistantVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/AudioFormat.ts b/src/api/types/AudioFormat.ts new file mode 100644 index 00000000..009af6d0 --- /dev/null +++ b/src/api/types/AudioFormat.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface AudioFormat { + /** + * This is the sample rate of the call. + * + * @default 16000 + */ + sampleRate: number; + /** + * This is the audio format of the call. + * + * @default 'pcm_s16le' + */ + format: Record; + /** + * This is the container format of the call. + * + * @default 'raw' + */ + container?: Vapi.AudioFormatContainer | undefined; +} diff --git a/src/api/types/AudioFormatContainer.ts b/src/api/types/AudioFormatContainer.ts new file mode 100644 index 00000000..bb3f40ca --- /dev/null +++ b/src/api/types/AudioFormatContainer.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the container format of the call. + * + * @default 'raw' + */ +export const AudioFormatContainer = { + Raw: "raw", +} as const; +export type AudioFormatContainer = (typeof AudioFormatContainer)[keyof typeof AudioFormatContainer]; diff --git a/src/api/types/AwsStsAuthenticationPlan.ts b/src/api/types/AwsStsAuthenticationPlan.ts index 92265580..55bec9a6 100644 --- a/src/api/types/AwsStsAuthenticationPlan.ts +++ b/src/api/types/AwsStsAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * AWS Security Token Service role-assumption configuration used to authenticate requests. + */ export interface AwsStsAuthenticationPlan { /** This is the role ARN for the AWS credential */ roleArn: string; diff --git a/src/api/types/AwsiamCredentialsAuthenticationPlan.ts b/src/api/types/AwsiamCredentialsAuthenticationPlan.ts index cb7a2474..713e5a4e 100644 --- a/src/api/types/AwsiamCredentialsAuthenticationPlan.ts +++ b/src/api/types/AwsiamCredentialsAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Direct AWS IAM credentials used to authenticate requests. + */ export interface AwsiamCredentialsAuthenticationPlan { /** AWS Access Key ID. This is not returned in the API. */ awsAccessKeyId: string; diff --git a/src/api/types/AzureBlobStorageBucketPlan.ts b/src/api/types/AzureBlobStorageBucketPlan.ts index 387d857f..d9f62c49 100644 --- a/src/api/types/AzureBlobStorageBucketPlan.ts +++ b/src/api/types/AzureBlobStorageBucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Azure Blob Storage container configuration for call artifacts, including its connection string, container name, and storage path. + */ export interface AzureBlobStorageBucketPlan { /** This is the blob storage connection string for the Azure resource. */ connectionString: string; diff --git a/src/api/types/AzureCredentialRegion.ts b/src/api/types/AzureCredentialRegion.ts index 94517fad..845f8f10 100644 --- a/src/api/types/AzureCredentialRegion.ts +++ b/src/api/types/AzureCredentialRegion.ts @@ -20,6 +20,8 @@ export const AzureCredentialRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/AzureOpenAiCredentialModelsItem.ts b/src/api/types/AzureOpenAiCredentialModelsItem.ts index 6c02b1ff..435e1846 100644 --- a/src/api/types/AzureOpenAiCredentialModelsItem.ts +++ b/src/api/types/AzureOpenAiCredentialModelsItem.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. export const AzureOpenAiCredentialModelsItem = { + Gpt56Luna20260709: "gpt-5.6-luna-2026-07-09", + Gpt56Terra20260709: "gpt-5.6-terra-2026-07-09", + Gpt56Sol20260709: "gpt-5.6-sol-2026-07-09", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -24,6 +27,9 @@ export const AzureOpenAiCredentialModelsItem = { Gpt40613: "gpt-4-0613", Gpt35Turbo0125: "gpt-35-turbo-0125", Gpt35Turbo1106: "gpt-35-turbo-1106", + Gpt4O: "gpt-4o", + Gpt41: "gpt-4.1", + Gpt54Mini20260317: "gpt-5.4-mini-2026-03-17", } as const; export type AzureOpenAiCredentialModelsItem = (typeof AzureOpenAiCredentialModelsItem)[keyof typeof AzureOpenAiCredentialModelsItem]; diff --git a/src/api/types/AzureOpenAiCredentialRegion.ts b/src/api/types/AzureOpenAiCredentialRegion.ts index a879350f..a64f5654 100644 --- a/src/api/types/AzureOpenAiCredentialRegion.ts +++ b/src/api/types/AzureOpenAiCredentialRegion.ts @@ -19,6 +19,8 @@ export const AzureOpenAiCredentialRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/AzureSpeechTranscriber.ts b/src/api/types/AzureSpeechTranscriber.ts index 87868250..e7e00a7f 100644 --- a/src/api/types/AzureSpeechTranscriber.ts +++ b/src/api/types/AzureSpeechTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Azure Speech, including language, segmentation, and fallback settings. + */ export interface AzureSpeechTranscriber { /** This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt */ language?: Vapi.AzureSpeechTranscriberLanguage | undefined; diff --git a/src/api/types/AzureVoice.ts b/src/api/types/AzureVoice.ts index f28e516b..3fc4b156 100644 --- a/src/api/types/AzureVoice.ts +++ b/src/api/types/AzureVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, and fallback settings. + */ export interface AzureVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/BackgroundSpeechDenoisingPlan.ts b/src/api/types/BackgroundSpeechDenoisingPlan.ts index fbfbca1a..f0b37f08 100644 --- a/src/api/types/BackgroundSpeechDenoisingPlan.ts +++ b/src/api/types/BackgroundSpeechDenoisingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls smart and Fourier denoising applied to customer audio before transcription. + */ export interface BackgroundSpeechDenoisingPlan { /** Whether smart denoising using Krisp is enabled. */ smartDenoisingPlan?: Vapi.SmartDenoisingPlan | undefined; diff --git a/src/api/types/BackoffPlan.ts b/src/api/types/BackoffPlan.ts index ae617e1d..2d951867 100644 --- a/src/api/types/BackoffPlan.ts +++ b/src/api/types/BackoffPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status codes excluded from retries. + */ export interface BackoffPlan { /** * This is the type of backoff plan to use. Defaults to fixed. @@ -13,11 +16,8 @@ export interface BackoffPlan { * @default 0 */ maxRetries: number; - /** 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. */ + /** Base delay in seconds. For fixed backoff, this is the delay between retries. For exponential backoff, this is the initial delay. */ baseDelaySeconds: number; - /** - * This is the excluded status codes. If the response status code is in this list, the request will not be retried. - * By default, the request will be retried for any non-2xx status code. - */ + /** HTTP status codes that should not trigger a retry. By default, any non-2xx status code not listed here can be retried. */ excludedStatusCodes?: Record[] | undefined; } diff --git a/src/api/types/BarInsight.ts b/src/api/types/BarInsight.ts index 6d2cb765..27d5967e 100644 --- a/src/api/types/BarInsight.ts +++ b/src/api/types/BarInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ export interface BarInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface BarInsight { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. @@ -42,4 +46,6 @@ export interface BarInsight { createdAt: string; /** This is the ISO 8601 date-time string of when the Insight was last updated. */ updatedAt: string; + /** Stable server-owned identifier for system-created insights. */ + systemKey?: string | undefined; } diff --git a/src/api/types/BarInsightMetadata.ts b/src/api/types/BarInsightMetadata.ts index 9b44b3d6..228e661b 100644 --- a/src/api/types/BarInsightMetadata.ts +++ b/src/api/types/BarInsightMetadata.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds. + */ export interface BarInsightMetadata { + /** Label displayed on the chart's x-axis. */ xAxisLabel?: string | undefined; + /** Label displayed on the chart's y-axis. */ yAxisLabel?: string | undefined; + /** Minimum value displayed on the chart's y-axis. */ yAxisMin?: number | undefined; + /** Maximum value displayed on the chart's y-axis. */ yAxisMax?: number | undefined; + /** Display name for the insight chart. */ name?: string | undefined; } diff --git a/src/api/types/BashTool.ts b/src/api/types/BashTool.ts index 5c1044ba..ff9b8a4c 100644 --- a/src/api/types/BashTool.ts +++ b/src/api/types/BashTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that executes shell commands in a configured environment. + */ export interface BashTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.BashToolMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.BashToolSubType; diff --git a/src/api/types/BashToolWithToolCall.ts b/src/api/types/BashToolWithToolCall.ts index 8e60e2b9..0a711213 100644 --- a/src/api/types/BashToolWithToolCall.ts +++ b/src/api/types/BashToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface BashToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.BashToolWithToolCallMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.BashToolWithToolCallSubType; diff --git a/src/api/types/BearerAuthenticationPlan.ts b/src/api/types/BearerAuthenticationPlan.ts index 48a069ff..15f8e8ef 100644 --- a/src/api/types/BearerAuthenticationPlan.ts +++ b/src/api/types/BearerAuthenticationPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Configuration for authenticating outbound requests with a bearer token, including header name and optional `Bearer` prefix. + */ export interface BearerAuthenticationPlan { /** This is the bearer token value. */ token: string; diff --git a/src/api/types/Board.ts b/src/api/types/Board.ts new file mode 100644 index 00000000..76fc8e7e --- /dev/null +++ b/src/api/types/Board.ts @@ -0,0 +1,31 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface Board { + /** This is the contents of the Board, which is an array of objects defining the type, contents, and position of the widgets on the Board. */ + items?: Vapi.BoardItemsItem[] | undefined; + /** This is the unique identifier for the Board. */ + id: string; + /** This is the unique identifier for the org that this Board belongs to. */ + orgId: string; + /** This is the ISO 8601 date-time string of when the Board was created. */ + createdAt: string; + /** This is the ISO 8601 date-time string of when the Board was last updated. */ + updatedAt: string; + /** + * Server-owned key for system-provisioned boards. User create/update DTOs do + * not accept this field. + */ + systemKey?: string | undefined; + /** This is the name of the Board. */ + name: string; + /** This is the layout of the Board. */ + layout: Vapi.BoardLayout; + /** + * This is the timerange override for the board. + * By default, individual insights have their own timerange. + * This is a global override for the board which will be passed to all insights on the board. + */ + timeRangeOverride?: Vapi.InsightTimeRangeWithStep | undefined; +} diff --git a/src/api/types/BoardInsightItem.ts b/src/api/types/BoardInsightItem.ts new file mode 100644 index 00000000..d902da00 --- /dev/null +++ b/src/api/types/BoardInsightItem.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface BoardInsightItem { + type: Vapi.BoardInsightItemType; + insightId: string; + systemKey?: string | undefined; + position: Vapi.BoardItemPosition; + size: Vapi.BoardItemSize; +} diff --git a/src/api/types/BoardInsightItemType.ts b/src/api/types/BoardInsightItemType.ts new file mode 100644 index 00000000..4e662f63 --- /dev/null +++ b/src/api/types/BoardInsightItemType.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export const BoardInsightItemType = { + Insight: "insight", +} as const; +export type BoardInsightItemType = (typeof BoardInsightItemType)[keyof typeof BoardInsightItemType]; diff --git a/src/api/types/BoardItemPosition.ts b/src/api/types/BoardItemPosition.ts new file mode 100644 index 00000000..f52a81a4 --- /dev/null +++ b/src/api/types/BoardItemPosition.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface BoardItemPosition { + x: number; + y: number; +} diff --git a/src/api/types/BoardItemSize.ts b/src/api/types/BoardItemSize.ts new file mode 100644 index 00000000..a74c7b80 --- /dev/null +++ b/src/api/types/BoardItemSize.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface BoardItemSize { + width: number; + height: number; +} diff --git a/src/api/types/BoardItemsItem.ts b/src/api/types/BoardItemsItem.ts new file mode 100644 index 00000000..1c9ee67f --- /dev/null +++ b/src/api/types/BoardItemsItem.ts @@ -0,0 +1,5 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type BoardItemsItem = Vapi.BoardInsightItem | Vapi.BoardMetricWidgetItem; diff --git a/src/api/types/BoardLayout.ts b/src/api/types/BoardLayout.ts new file mode 100644 index 00000000..9b8fcb70 --- /dev/null +++ b/src/api/types/BoardLayout.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface BoardLayout { + /** + * This is the number of columns in the Board. + * For now, it is fixed to 6. + */ + columns: number; +} diff --git a/src/api/types/BoardMetricWidgetItem.ts b/src/api/types/BoardMetricWidgetItem.ts new file mode 100644 index 00000000..b20729e1 --- /dev/null +++ b/src/api/types/BoardMetricWidgetItem.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface BoardMetricWidgetItem { + type: Vapi.BoardMetricWidgetItemType; + position: Vapi.BoardItemPosition; + size: Vapi.BoardItemSize; + insightId?: string | undefined; + systemKey?: string | undefined; +} diff --git a/src/api/types/BoardMetricWidgetItemType.ts b/src/api/types/BoardMetricWidgetItemType.ts new file mode 100644 index 00000000..4593f6f8 --- /dev/null +++ b/src/api/types/BoardMetricWidgetItemType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const BoardMetricWidgetItemType = { + FailedCallsList: "failed_calls_list", + ConcurrencyChart: "concurrency_chart", + AverageCostBreakdownChart: "average_cost_breakdown_chart", +} as const; +export type BoardMetricWidgetItemType = (typeof BoardMetricWidgetItemType)[keyof typeof BoardMetricWidgetItemType]; diff --git a/src/api/types/BoardPaginatedResponse.ts b/src/api/types/BoardPaginatedResponse.ts new file mode 100644 index 00000000..284d660e --- /dev/null +++ b/src/api/types/BoardPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface BoardPaginatedResponse { + results: Vapi.Board[]; + metadata: Vapi.PaginationMeta; +} diff --git a/src/api/types/BooleanComparatorScorecardMetricCondition.ts b/src/api/types/BooleanComparatorScorecardMetricCondition.ts new file mode 100644 index 00000000..6ea7dfc7 --- /dev/null +++ b/src/api/types/BooleanComparatorScorecardMetricCondition.ts @@ -0,0 +1,20 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface BooleanComparatorScorecardMetricCondition { + /** This is the type of the condition. Currently only 'comparator' is supported. */ + type: Vapi.BooleanComparatorScorecardMetricConditionType; + /** The comparator can only be '=' for boolean conditions. */ + comparator: Vapi.BooleanComparatorScorecardMetricConditionComparator; + /** + * This is the value that will be used to compare the result of the structured output with the comparator. + * If the result of the comparison is true, the points will be added to the overall score. + */ + value: boolean; + /** + * These are the points that will be added to the overall score if the condition is met. + * The points must be between 0 and 100. + */ + points: number; +} diff --git a/src/api/types/BooleanComparatorScorecardMetricConditionComparator.ts b/src/api/types/BooleanComparatorScorecardMetricConditionComparator.ts new file mode 100644 index 00000000..d64c0ac8 --- /dev/null +++ b/src/api/types/BooleanComparatorScorecardMetricConditionComparator.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The comparator can only be '=' for boolean conditions. */ +export const BooleanComparatorScorecardMetricConditionComparator = { + EqualTo: "=", +} as const; +export type BooleanComparatorScorecardMetricConditionComparator = + (typeof BooleanComparatorScorecardMetricConditionComparator)[keyof typeof BooleanComparatorScorecardMetricConditionComparator]; diff --git a/src/api/types/BooleanComparatorScorecardMetricConditionType.ts b/src/api/types/BooleanComparatorScorecardMetricConditionType.ts new file mode 100644 index 00000000..1235bf36 --- /dev/null +++ b/src/api/types/BooleanComparatorScorecardMetricConditionType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the condition. Currently only 'comparator' is supported. */ +export const BooleanComparatorScorecardMetricConditionType = { + Comparator: "comparator", +} as const; +export type BooleanComparatorScorecardMetricConditionType = + (typeof BooleanComparatorScorecardMetricConditionType)[keyof typeof BooleanComparatorScorecardMetricConditionType]; diff --git a/src/api/types/BotMessage.ts b/src/api/types/BotMessage.ts index b7f4a632..59ada8ea 100644 --- a/src/api/types/BotMessage.ts +++ b/src/api/types/BotMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An assistant-authored entry in the call message history, including content, timing, source, and duration. + */ export interface BotMessage { /** The role of the bot in the conversation. */ role: string; @@ -15,4 +18,15 @@ export interface BotMessage { source?: string | undefined; /** The duration of the message in seconds. */ duration?: number | undefined; + /** + * The name of the assistant that produced this message. In a squad or + * handoff call this is the specific sub-agent active when the message was + * spoken, letting the transcript label each message by speaker. + */ + assistantName?: string | undefined; + /** + * The ID of the assistant that produced this message. Stable reference for + * the assistant named in `assistantName`. + */ + assistantId?: string | undefined; } diff --git a/src/api/types/BothCustomEndpointingRule.ts b/src/api/types/BothCustomEndpointingRule.ts index 32bca870..a7aa48b1 100644 --- a/src/api/types/BothCustomEndpointingRule.ts +++ b/src/api/types/BothCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches both the assistant's last message and the customer's current speech before applying a configured timeout. + */ export interface BothCustomEndpointingRule { /** * This is the regex pattern to match the assistant's message. @@ -20,6 +23,7 @@ export interface BothCustomEndpointingRule { * @default [] */ assistantRegexOptions?: Vapi.RegexOption[] | undefined; + /** The regular expression pattern matched against the customer's speech. */ customerRegex: string; /** * These are the options for the customer's message regex match. Defaults to all disabled. diff --git a/src/api/types/BucketPlan.ts b/src/api/types/BucketPlan.ts index 7b3e5406..65ace125 100644 --- a/src/api/types/BucketPlan.ts +++ b/src/api/types/BucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional HMAC credentials. + */ export interface BucketPlan { /** This is the name of the bucket. */ name: string; diff --git a/src/api/types/ByoPhoneNumber.ts b/src/api/types/ByoPhoneNumber.ts index e0d5f314..7c48d283 100644 --- a/src/api/types/ByoPhoneNumber.ts +++ b/src/api/types/ByoPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface ByoPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/ByoSipTrunkCredential.ts b/src/api/types/ByoSipTrunkCredential.ts index d8911a34..52130ea2 100644 --- a/src/api/types/ByoSipTrunkCredential.ts +++ b/src/api/types/ByoSipTrunkCredential.ts @@ -32,6 +32,4 @@ export interface ByoSipTrunkCredential { techPrefix?: string | undefined; /** This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property. */ sipDiversionHeader?: string | undefined; - /** This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi. */ - sbcConfiguration?: Vapi.SbcConfiguration | undefined; } diff --git a/src/api/types/Call.ts b/src/api/types/Call.ts index e30089e6..8896a4e4 100644 --- a/src/api/types/Call.ts +++ b/src/api/types/Call.ts @@ -2,11 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A call record returned by Vapi. It contains the configuration and resources used for the call, its lifecycle status and timestamps, conversation messages, artifacts, analysis, and costs. + */ export interface Call { /** This is the type of call. */ type?: Vapi.CallType | undefined; /** These are the costs of individual components of the call in USD. */ costs?: Vapi.CallCostsItem[] | undefined; + /** Messages exchanged during the call, including user, assistant, system, tool-call, and tool-result messages. */ messages?: Vapi.CallMessagesItem[] | undefined; /** * This is the provider of the call. @@ -28,6 +32,13 @@ export interface Call { endedMessage?: string | undefined; /** This is the destination where the call ended up being transferred to. If the call was not transferred, this will be empty. */ destination?: Vapi.CallDestination | undefined; + /** + * This is the assistant version to use for this call. Supported only with + * direct `assistantId`. Omit to follow the latest version. + */ + assistantVersion?: (string | null) | undefined; + /** This is the transport of the call. */ + transport?: Vapi.CallTransport | undefined; /** This is the unique identifier for the call. */ id: string; /** This is the unique identifier for the org that this call belongs to. */ @@ -153,8 +164,4 @@ export interface Call { name?: string | undefined; /** This is the schedule plan of the call. */ schedulePlan?: Vapi.SchedulePlan | undefined; - /** This is the transport of the call. */ - transport?: Record | undefined; - /** These are the subscription limits for the org at the time of the call. Includes concurrency limit information. */ - subscriptionLimits?: Vapi.SubscriptionLimits | undefined; } diff --git a/src/api/types/CallArtifactUploadItem.ts b/src/api/types/CallArtifactUploadItem.ts new file mode 100644 index 00000000..a2ba5052 --- /dev/null +++ b/src/api/types/CallArtifactUploadItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CallArtifactUploadItem { + /** The artifact this result refers to. */ + type: Vapi.CallArtifactUploadItemType; + /** Whether this artifact was stored successfully in your own configured storage. */ + success: boolean; +} diff --git a/src/api/types/CallArtifactUploadItemType.ts b/src/api/types/CallArtifactUploadItemType.ts new file mode 100644 index 00000000..a48b8054 --- /dev/null +++ b/src/api/types/CallArtifactUploadItemType.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The artifact this result refers to. */ +export const CallArtifactUploadItemType = { + EndOfCallReport: "end-of-call-report", + RecordingMono: "recording-mono", + RecordingStereo: "recording-stereo", + RecordingAssistant: "recording-assistant", + RecordingCustomer: "recording-customer", + Log: "log", + Pcap: "pcap", +} as const; +export type CallArtifactUploadItemType = (typeof CallArtifactUploadItemType)[keyof typeof CallArtifactUploadItemType]; diff --git a/src/api/types/CallBatchError.ts b/src/api/types/CallBatchError.ts index 7a1021bd..6356ef2f 100644 --- a/src/api/types/CallBatchError.ts +++ b/src/api/types/CallBatchError.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Error returned for one customer entry in a batch call request. + */ export interface CallBatchError { + /** Customer configuration associated with the failed call. */ customer: Vapi.CreateCustomerDto; + /** Error message explaining why the call could not be created. */ error: string; } diff --git a/src/api/types/CallBatchResponse.ts b/src/api/types/CallBatchResponse.ts index bd746dd1..27dc63fc 100644 --- a/src/api/types/CallBatchResponse.ts +++ b/src/api/types/CallBatchResponse.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The result of a batch call creation request, containing successfully created calls, per-call failures, and subscription limits recorded at the end of the batch. + */ export interface CallBatchResponse { /** Subscription limits at the end of this batch */ subscriptionLimits?: Vapi.SubscriptionLimits | undefined; diff --git a/src/api/types/CallEndedReason.ts b/src/api/types/CallEndedReason.ts index 04973817..16d9e75e 100644 --- a/src/api/types/CallEndedReason.ts +++ b/src/api/types/CallEndedReason.ts @@ -27,6 +27,7 @@ export const CallEndedReason = { CallStartErrorSubscriptionConcurrencyLimitReached: "call.start.error-subscription-concurrency-limit-reached", CallStartErrorEnterpriseFeatureNotAvailableRecordingConsent: "call.start.error-enterprise-feature-not-available-recording-consent", + CallStartAssistantVersionErrorValidation: "call.start.assistant-version-error-validation", AssistantNotValid: "assistant-not-valid", CallStartErrorVapifaultDatabaseError: "call.start.error-vapifault-database-error", AssistantNotFound: "assistant-not-found", @@ -46,6 +47,9 @@ export const CallEndedReason = { PipelineErrorInworldVoiceFailed: "pipeline-error-inworld-voice-failed", PipelineErrorMinimaxVoiceFailed: "pipeline-error-minimax-voice-failed", PipelineErrorWellsaidVoiceFailed: "pipeline-error-wellsaid-voice-failed", + PipelineErrorXaiVoiceFailed: "pipeline-error-xai-voice-failed", + PipelineErrorMicrosoftVoiceFailed: "pipeline-error-microsoft-voice-failed", + PipelineErrorMicrosoftVoiceRequestCanceled: "pipeline-error-microsoft-voice-request-canceled", PipelineErrorTavusVideoFailed: "pipeline-error-tavus-video-failed", CallInProgressErrorVapifaultOpenaiVoiceFailed: "call.in-progress.error-vapifault-openai-voice-failed", CallInProgressErrorVapifaultCartesiaVoiceFailed: "call.in-progress.error-vapifault-cartesia-voice-failed", @@ -63,6 +67,8 @@ export const CallEndedReason = { CallInProgressErrorVapifaultInworldVoiceFailed: "call.in-progress.error-vapifault-inworld-voice-failed", CallInProgressErrorVapifaultMinimaxVoiceFailed: "call.in-progress.error-vapifault-minimax-voice-failed", CallInProgressErrorVapifaultWellsaidVoiceFailed: "call.in-progress.error-vapifault-wellsaid-voice-failed", + CallInProgressErrorVapifaultXaiVoiceFailed: "call.in-progress.error-vapifault-xai-voice-failed", + CallInProgressErrorVapifaultMicrosoftVoiceFailed: "call.in-progress.error-vapifault-microsoft-voice-failed", CallInProgressErrorVapifaultTavusVideoFailed: "call.in-progress.error-vapifault-tavus-video-failed", PipelineErrorVapiLlmFailed: "pipeline-error-vapi-llm-failed", PipelineErrorVapi400BadRequestValidationFailed: "pipeline-error-vapi-400-bad-request-validation-failed", @@ -72,6 +78,7 @@ export const CallEndedReason = { PipelineErrorVapi500ServerError: "pipeline-error-vapi-500-server-error", PipelineErrorVapi503ServerOverloadedError: "pipeline-error-vapi-503-server-overloaded-error", CallInProgressErrorProviderfaultVapiLlmFailed: "call.in-progress.error-providerfault-vapi-llm-failed", + CallInProgressErrorVapifaultVapiLlmFailed: "call.in-progress.error-vapifault-vapi-llm-failed", CallInProgressErrorVapifaultVapi400BadRequestValidationFailed: "call.in-progress.error-vapifault-vapi-400-bad-request-validation-failed", CallInProgressErrorVapifaultVapi401Unauthorized: "call.in-progress.error-vapifault-vapi-401-unauthorized", @@ -81,6 +88,11 @@ export const CallEndedReason = { CallInProgressErrorProviderfaultVapi500ServerError: "call.in-progress.error-providerfault-vapi-500-server-error", CallInProgressErrorProviderfaultVapi503ServerOverloadedError: "call.in-progress.error-providerfault-vapi-503-server-overloaded-error", + PipelineErrorVapiTranscriberFailed: "pipeline-error-vapi-transcriber-failed", + CallInProgressErrorVapifaultVapiTranscriberFailed: "call.in-progress.error-vapifault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiTranscriberFailed: + "call.in-progress.error-providerfault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiVoiceFailed: "call.in-progress.error-providerfault-vapi-voice-failed", PipelineErrorDeepgramTranscriberFailed: "pipeline-error-deepgram-transcriber-failed", PipelineErrorDeepgramTranscriberApiKeyMissing: "pipeline-error-deepgram-transcriber-api-key-missing", CallInProgressErrorVapifaultDeepgramTranscriberFailed: @@ -137,6 +149,23 @@ export const CallEndedReason = { CallInProgressErrorVapifaultSonioxTranscriberServerError: "call.in-progress.error-vapifault-soniox-transcriber-server-error", CallInProgressErrorVapifaultSonioxTranscriberFailed: "call.in-progress.error-vapifault-soniox-transcriber-failed", + PipelineErrorXaiTranscriberAuthFailed: "pipeline-error-xai-transcriber-auth-failed", + PipelineErrorXaiTranscriberRateLimited: "pipeline-error-xai-transcriber-rate-limited", + PipelineErrorXaiTranscriberInvalidConfig: "pipeline-error-xai-transcriber-invalid-config", + PipelineErrorXaiTranscriberServerError: "pipeline-error-xai-transcriber-server-error", + PipelineErrorXaiTranscriberFailed: "pipeline-error-xai-transcriber-failed", + CallInProgressErrorVapifaultXaiTranscriberAuthFailed: + "call.in-progress.error-vapifault-xai-transcriber-auth-failed", + CallInProgressErrorVapifaultXaiTranscriberRateLimited: + "call.in-progress.error-vapifault-xai-transcriber-rate-limited", + CallInProgressErrorVapifaultXaiTranscriberInvalidConfig: + "call.in-progress.error-vapifault-xai-transcriber-invalid-config", + CallInProgressErrorVapifaultXaiTranscriberServerError: + "call.in-progress.error-vapifault-xai-transcriber-server-error", + CallInProgressErrorVapifaultXaiTranscriberFailed: "call.in-progress.error-vapifault-xai-transcriber-failed", + PipelineErrorCartesiaTranscriberFailed: "pipeline-error-cartesia-transcriber-failed", + CallInProgressErrorVapifaultCartesiaTranscriberFailed: + "call.in-progress.error-vapifault-cartesia-transcriber-failed", CallInProgressErrorPipelineNoAvailableLlmModel: "call.in-progress.error-pipeline-no-available-llm-model", WorkerShutdown: "worker-shutdown", VonageDisconnected: "vonage-disconnected", @@ -749,6 +778,7 @@ export const CallEndedReason = { ManuallyCanceled: "manually-canceled", PhoneCallProviderClosedWebsocket: "phone-call-provider-closed-websocket", CallForwardingOperatorBusy: "call.forwarding.operator-busy", + CallForwardingNoAnswer: "call.forwarding.no-answer", SilenceTimedOut: "silence-timed-out", CallInProgressErrorProviderfaultOutboundSip403Forbidden: "call.in-progress.error-providerfault-outbound-sip-403-forbidden", diff --git a/src/api/types/CallHookAssistantSpeechInterrupted.ts b/src/api/types/CallHookAssistantSpeechInterrupted.ts index 5798c755..74814f39 100644 --- a/src/api/types/CallHookAssistantSpeechInterrupted.ts +++ b/src/api/types/CallHookAssistantSpeechInterrupted.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the customer's speech interrupts the assistant. + */ export interface CallHookAssistantSpeechInterrupted { /** This is the event that triggers this hook */ on: Vapi.CallHookAssistantSpeechInterruptedOn; diff --git a/src/api/types/CallHookAssistantSpeechInterruptedDoItem.ts b/src/api/types/CallHookAssistantSpeechInterruptedDoItem.ts index 324db7a7..8616e496 100644 --- a/src/api/types/CallHookAssistantSpeechInterruptedDoItem.ts +++ b/src/api/types/CallHookAssistantSpeechInterruptedDoItem.ts @@ -19,4 +19,9 @@ export namespace CallHookAssistantSpeechInterruptedDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = + | Vapi.CallHookAssistantSpeechInterruptedDoItem.Say + | Vapi.CallHookAssistantSpeechInterruptedDoItem.Tool + | Vapi.CallHookAssistantSpeechInterruptedDoItem.MessageAdd; } diff --git a/src/api/types/CallHookCallEnding.ts b/src/api/types/CallHookCallEnding.ts index aae89795..e968fa34 100644 --- a/src/api/types/CallHookCallEnding.ts +++ b/src/api/types/CallHookCallEnding.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when a call is ending, optionally only when its filters match. + */ export interface CallHookCallEnding { /** This is the event that triggers this hook */ on: Vapi.CallHookCallEndingOn; diff --git a/src/api/types/CallHookCallEndingDoItem.ts b/src/api/types/CallHookCallEndingDoItem.ts index 7da2d7c7..2d3afa86 100644 --- a/src/api/types/CallHookCallEndingDoItem.ts +++ b/src/api/types/CallHookCallEndingDoItem.ts @@ -12,4 +12,6 @@ export namespace CallHookCallEndingDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = Vapi.CallHookCallEndingDoItem.Tool | Vapi.CallHookCallEndingDoItem.MessageAdd; } diff --git a/src/api/types/CallHookCustomerSpeechInterrupted.ts b/src/api/types/CallHookCustomerSpeechInterrupted.ts index 1a821565..9c237116 100644 --- a/src/api/types/CallHookCustomerSpeechInterrupted.ts +++ b/src/api/types/CallHookCustomerSpeechInterrupted.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the assistant interrupts the customer's speech. + */ export interface CallHookCustomerSpeechInterrupted { /** This is the event that triggers this hook */ on: Vapi.CallHookCustomerSpeechInterruptedOn; diff --git a/src/api/types/CallHookCustomerSpeechInterruptedDoItem.ts b/src/api/types/CallHookCustomerSpeechInterruptedDoItem.ts index 393095d3..96b7d9b0 100644 --- a/src/api/types/CallHookCustomerSpeechInterruptedDoItem.ts +++ b/src/api/types/CallHookCustomerSpeechInterruptedDoItem.ts @@ -19,4 +19,9 @@ export namespace CallHookCustomerSpeechInterruptedDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = + | Vapi.CallHookCustomerSpeechInterruptedDoItem.Say + | Vapi.CallHookCustomerSpeechInterruptedDoItem.Tool + | Vapi.CallHookCustomerSpeechInterruptedDoItem.MessageAdd; } diff --git a/src/api/types/CallHookCustomerSpeechTimeout.ts b/src/api/types/CallHookCustomerSpeechTimeout.ts index 1a625aa6..22bceaf9 100644 --- a/src/api/types/CallHookCustomerSpeechTimeout.ts +++ b/src/api/types/CallHookCustomerSpeechTimeout.ts @@ -2,12 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the customer does not speak before the configured timeout, with support for trigger limits and named instances. + */ export interface CallHookCustomerSpeechTimeout { /** Must be either "customer.speech.timeout" or match the pattern "customer.speech.timeout[property=value]" */ on: string; /** This is the set of actions to perform when the hook triggers */ do: Vapi.CallHookCustomerSpeechTimeoutDoItem[]; - /** This is the set of filters that must match for the hook to trigger */ + /** Controls the speech timeout, maximum trigger count, and counter reset behavior for this hook. */ options?: Vapi.CustomerSpeechTimeoutOptions | undefined; /** * This is the name of the hook, it can be set by the user to identify the hook. diff --git a/src/api/types/CallHookCustomerSpeechTimeoutDoItem.ts b/src/api/types/CallHookCustomerSpeechTimeoutDoItem.ts index 536186d7..7d392d8c 100644 --- a/src/api/types/CallHookCustomerSpeechTimeoutDoItem.ts +++ b/src/api/types/CallHookCustomerSpeechTimeoutDoItem.ts @@ -19,4 +19,9 @@ export namespace CallHookCustomerSpeechTimeoutDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = + | Vapi.CallHookCustomerSpeechTimeoutDoItem.Say + | Vapi.CallHookCustomerSpeechTimeoutDoItem.Tool + | Vapi.CallHookCustomerSpeechTimeoutDoItem.MessageAdd; } diff --git a/src/api/types/CallHookFilter.ts b/src/api/types/CallHookFilter.ts index c89c5bbb..27e6bb9e 100644 --- a/src/api/types/CallHookFilter.ts +++ b/src/api/types/CallHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches a call field against one or more allowed values to determine whether a hook runs. + */ export interface CallHookFilter { /** This is the type of filter - currently only "oneOf" is supported */ type: Vapi.CallHookFilterType; diff --git a/src/api/types/CallHookModelResponseTimeout.ts b/src/api/types/CallHookModelResponseTimeout.ts index 69c400c8..60c6d2c0 100644 --- a/src/api/types/CallHookModelResponseTimeout.ts +++ b/src/api/types/CallHookModelResponseTimeout.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured actions when the language model does not respond before its timeout. + */ export interface CallHookModelResponseTimeout { /** This is the event that triggers this hook */ on: Vapi.CallHookModelResponseTimeoutOn; diff --git a/src/api/types/CallHookModelResponseTimeoutDoItem.ts b/src/api/types/CallHookModelResponseTimeoutDoItem.ts index fe6b1d40..20db95b6 100644 --- a/src/api/types/CallHookModelResponseTimeoutDoItem.ts +++ b/src/api/types/CallHookModelResponseTimeoutDoItem.ts @@ -19,4 +19,9 @@ export namespace CallHookModelResponseTimeoutDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = + | Vapi.CallHookModelResponseTimeoutDoItem.Say + | Vapi.CallHookModelResponseTimeoutDoItem.Tool + | Vapi.CallHookModelResponseTimeoutDoItem.MessageAdd; } diff --git a/src/api/types/CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.ts b/src/api/types/CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.ts index 6b916997..e5afdd1d 100644 --- a/src/api/types/CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.ts +++ b/src/api/types/CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.ts @@ -19,4 +19,9 @@ export namespace CallHookTranscriberEndpointedSpeechLowConfidenceDoItem { export interface MessageAdd extends Vapi.MessageAddHookAction { type: "message.add"; } + + export type Response = + | Vapi.CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.Say + | Vapi.CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.Tool + | Vapi.CallHookTranscriberEndpointedSpeechLowConfidenceDoItem.MessageAdd; } diff --git a/src/api/types/CallTransport.ts b/src/api/types/CallTransport.ts new file mode 100644 index 00000000..d7804107 --- /dev/null +++ b/src/api/types/CallTransport.ts @@ -0,0 +1,40 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the transport of the call. + */ +export type CallTransport = + | Vapi.CallTransport.VapiWebsocket + | Vapi.CallTransport.Vonage + | Vapi.CallTransport.Twilio + | Vapi.CallTransport.VapiSip + | Vapi.CallTransport.Telnyx + | Vapi.CallTransport.Daily; + +export namespace CallTransport { + export interface VapiWebsocket extends Vapi.VapiWebsocketTransport { + provider: "vapi.websocket"; + } + + export interface Vonage extends Vapi.VonageTransport { + provider: "vonage"; + } + + export interface Twilio extends Vapi.TwilioTransport { + provider: "twilio"; + } + + export interface VapiSip extends Vapi.VapiSipTransport { + provider: "vapi.sip"; + } + + export interface Telnyx extends Vapi.TelnyxTransport { + provider: "telnyx"; + } + + export interface Daily extends Vapi.VapiWebCallTransport { + provider: "daily"; + } +} diff --git a/src/api/types/Campaign.ts b/src/api/types/Campaign.ts index c7d1aa6a..7df3efb1 100644 --- a/src/api/types/Campaign.ts +++ b/src/api/types/Campaign.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and call-progress counters. + */ export interface Campaign { /** This is the status of the campaign. */ status: Vapi.CampaignStatus; @@ -21,8 +24,20 @@ export interface Campaign { dialPlan?: Vapi.DialPlanEntry[] | undefined; /** This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried. */ schedulePlan?: Vapi.SchedulePlan | undefined; - /** These are the customers that will be called in the campaign. Required if dialPlan is not provided. */ + /** These are the customers that will be called in the campaign. Required if dialPlan is not provided. Maximum of 10000 customers per campaign. */ customers?: Vapi.CreateCustomerDto[] | undefined; + /** This is the maximum number of concurrent calls that will be made for the campaign. Defaults to 10. */ + maxConcurrency?: number | undefined; + /** These are the overrides for the assistant's settings and template variables for the campaign. Use this when the campaign targets an `assistantId`. */ + assistantOverrides?: Vapi.AssistantOverrides | undefined; + /** These are the overrides for the squad and template variables for the campaign. Use this when the campaign targets a `squadId`. Per-contact `squadOverrides` are deep-merged on top of this at dispatch time. */ + squadOverrides?: Vapi.AssistantOverrides | undefined; + /** This is the server (URL, auth headers, timeout, etc.) for the campaign webhooks. */ + server?: Vapi.Server | undefined; + /** These are the messages that will be sent to your Server URL. */ + serverMessages?: Vapi.CampaignServerMessagesItem[] | undefined; + /** This opts the campaign into the blocking `campaign.predial` eligibility webhook. When set, every contact triggers a `campaign.predial` POST to the Server URL before dialing, and the response `{ eligible: boolean }` decides whether the call is placed. Requires `server`. When unset, no pre-dial webhook is sent. */ + predialPlan?: Vapi.CampaignPredialPlan | undefined; /** This is the unique identifier for the campaign. */ id: string; /** This is the unique identifier for the org that this campaign belongs to. */ diff --git a/src/api/types/CampaignCallMetrics.ts b/src/api/types/CampaignCallMetrics.ts new file mode 100644 index 00000000..af2858da --- /dev/null +++ b/src/api/types/CampaignCallMetrics.ts @@ -0,0 +1,15 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface CampaignCallMetrics { + /** + * This is the number of contacts a call was actually placed for. Contacts + * that were skipped, rejected before dialing, or failed to dispatch are not + * counted — no call existed, so there was nothing to answer. + */ + dialed: number; + /** + * This is the number of those calls a human picked up. Voicemail does not + * count. Divide by `dialed` for the pick-up rate. + */ + connected: number; +} diff --git a/src/api/types/CampaignContact.ts b/src/api/types/CampaignContact.ts new file mode 100644 index 00000000..cb7ce732 --- /dev/null +++ b/src/api/types/CampaignContact.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CampaignContact { + id: string; + campaignId: string; + orgId: string; + customerId?: string | undefined; + number: string; + name?: string | undefined; + assistantOverrides?: Vapi.AssistantOverrides | undefined; + /** Use this when the campaign targets a `squadId`. Mirrors the call-level `squadOverrides` field. Merged with the campaign-level squadOverrides at dispatch time. */ + squadOverrides?: Vapi.AssistantOverrides | undefined; + createdAt: string; +} diff --git a/src/api/types/CampaignContactCounters.ts b/src/api/types/CampaignContactCounters.ts new file mode 100644 index 00000000..e0710902 --- /dev/null +++ b/src/api/types/CampaignContactCounters.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface CampaignContactCounters { + pending: number; + dispatched: number; + completed: number; + failed: number; + skipped: number; + predialFailed: number; +} diff --git a/src/api/types/CampaignContactPaginatedResponse.ts b/src/api/types/CampaignContactPaginatedResponse.ts new file mode 100644 index 00000000..cdfc8a88 --- /dev/null +++ b/src/api/types/CampaignContactPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CampaignContactPaginatedResponse { + results: Vapi.CampaignContactWithOutcome[]; + metadata: Vapi.PaginationMeta; +} diff --git a/src/api/types/CampaignContactWithOutcome.ts b/src/api/types/CampaignContactWithOutcome.ts new file mode 100644 index 00000000..43e6f897 --- /dev/null +++ b/src/api/types/CampaignContactWithOutcome.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CampaignContactWithOutcome { + id: string; + number: string; + name?: string | undefined; + status: Vapi.CampaignContactWithOutcomeStatus; + callId?: string | undefined; + dispatchedAt?: string | undefined; + endedReason?: string | undefined; +} diff --git a/src/api/types/CampaignContactWithOutcomeStatus.ts b/src/api/types/CampaignContactWithOutcomeStatus.ts new file mode 100644 index 00000000..b43cc367 --- /dev/null +++ b/src/api/types/CampaignContactWithOutcomeStatus.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignContactWithOutcomeStatus = { + ContactPending: "contact.pending", + ContactDispatched: "contact.dispatched", + ContactCompleted: "contact.completed", + ContactFailed: "contact.failed", + ContactSkipped: "contact.skipped", + ContactPredialFailed: "contact.predial-failed", +} as const; +export type CampaignContactWithOutcomeStatus = + (typeof CampaignContactWithOutcomeStatus)[keyof typeof CampaignContactWithOutcomeStatus]; diff --git a/src/api/types/CampaignPaginatedResponse.ts b/src/api/types/CampaignPaginatedResponse.ts index 316e3c75..51a2d4cd 100644 --- a/src/api/types/CampaignPaginatedResponse.ts +++ b/src/api/types/CampaignPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of outbound calling campaigns and metadata describing the result set. + */ export interface CampaignPaginatedResponse { + /** The campaigns returned for the current page. */ results: Vapi.Campaign[]; + /** Pagination metadata for the campaign result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/CampaignPredialPlan.ts b/src/api/types/CampaignPredialPlan.ts new file mode 100644 index 00000000..f5f051cd --- /dev/null +++ b/src/api/types/CampaignPredialPlan.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface CampaignPredialPlan { + /** Whether the pre-dial eligibility webhook is active. Defaults to true when `predialPlan` is set. Set to false to keep the plan without running the webhook (useful when duplicating a campaign). */ + enabled?: boolean | undefined; +} diff --git a/src/api/types/CampaignServerMessagesItem.ts b/src/api/types/CampaignServerMessagesItem.ts new file mode 100644 index 00000000..8ef11a31 --- /dev/null +++ b/src/api/types/CampaignServerMessagesItem.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignServerMessagesItem = { + CampaignStarted: "campaign.started", + CampaignCancelled: "campaign.cancelled", + CampaignEnded: "campaign.ended", + CampaignArchived: "campaign.archived", + CampaignUnarchived: "campaign.unarchived", + ContactDispatched: "contact.dispatched", + ContactCompleted: "contact.completed", + ContactFailed: "contact.failed", + ContactSkipped: "contact.skipped", + ContactPredialFailed: "contact.predial-failed", + CampaignJobContinued: "campaign.job.continued", +} as const; +export type CampaignServerMessagesItem = (typeof CampaignServerMessagesItem)[keyof typeof CampaignServerMessagesItem]; diff --git a/src/api/types/CampaignStatus.ts b/src/api/types/CampaignStatus.ts index 2a28f3b2..e8e08069 100644 --- a/src/api/types/CampaignStatus.ts +++ b/src/api/types/CampaignStatus.ts @@ -5,5 +5,7 @@ export const CampaignStatus = { Scheduled: "scheduled", InProgress: "in-progress", Ended: "ended", + Cancelled: "cancelled", + Archived: "archived", } as const; export type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus]; diff --git a/src/api/types/CampaignSummary.ts b/src/api/types/CampaignSummary.ts new file mode 100644 index 00000000..e4290b69 --- /dev/null +++ b/src/api/types/CampaignSummary.ts @@ -0,0 +1,51 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CampaignSummary { + /** This is the status of the campaign. */ + status: Vapi.CampaignSummaryStatus; + /** This is the explanation for how the campaign ended. */ + endedReason?: Vapi.CampaignSummaryEndedReason | undefined; + /** This is the name of the campaign. This is just for your own reference. */ + name: string; + /** This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ + assistantId?: string | undefined; + /** This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ + squadId?: string | undefined; + /** This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive. */ + phoneNumberId?: string | undefined; + /** This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried. */ + schedulePlan?: Vapi.SchedulePlan | undefined; + /** This is the maximum number of concurrent calls that will be made for the campaign. Defaults to 10. */ + maxConcurrency?: number | undefined; + /** These are the overrides for the assistant's settings and template variables for the campaign. Use this when the campaign targets an `assistantId`. */ + assistantOverrides?: Vapi.AssistantOverrides | undefined; + /** These are the overrides for the squad and template variables for the campaign. Use this when the campaign targets a `squadId`. Per-contact `squadOverrides` are deep-merged on top of this at dispatch time. */ + squadOverrides?: Vapi.AssistantOverrides | undefined; + /** This is the server (URL, auth headers, timeout, etc.) for the campaign webhooks. */ + server?: Vapi.Server | undefined; + /** These are the messages that will be sent to your Server URL. */ + serverMessages?: Vapi.CampaignSummaryServerMessagesItem[] | undefined; + /** This opts the campaign into the blocking `campaign.predial` eligibility webhook. When set, every contact triggers a `campaign.predial` POST to the Server URL before dialing, and the response `{ eligible: boolean }` decides whether the call is placed. Requires `server`. When unset, no pre-dial webhook is sent. */ + predialPlan?: Vapi.CampaignPredialPlan | undefined; + /** + * These are the per-status contact counts for this campaign. Sum them for the + * campaign's total audience; `pending` plus `dispatched` is what is left to + * complete. + */ + contactCounters?: Vapi.CampaignContactCounters | undefined; + /** + * These are the call-level outcomes for this campaign — how many contacts + * were actually dialed, and how many of those a human picked up. + */ + callMetrics?: Vapi.CampaignCallMetrics | undefined; + /** This is the unique identifier for the campaign. */ + id: string; + /** This is the unique identifier for the org that this campaign belongs to. */ + orgId: string; + /** This is the ISO 8601 date-time string of when the campaign was created. */ + createdAt: string; + /** This is the ISO 8601 date-time string of when the campaign was last updated. */ + updatedAt: string; +} diff --git a/src/api/types/CampaignSummaryEndedReason.ts b/src/api/types/CampaignSummaryEndedReason.ts new file mode 100644 index 00000000..d258ace3 --- /dev/null +++ b/src/api/types/CampaignSummaryEndedReason.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the explanation for how the campaign ended. */ +export const CampaignSummaryEndedReason = { + CampaignScheduledEndedByUser: "campaign.scheduled.ended-by-user", + CampaignInProgressEndedByUser: "campaign.in-progress.ended-by-user", + CampaignEndedSuccess: "campaign.ended.success", +} as const; +export type CampaignSummaryEndedReason = (typeof CampaignSummaryEndedReason)[keyof typeof CampaignSummaryEndedReason]; diff --git a/src/api/types/CampaignSummaryPaginatedResponse.ts b/src/api/types/CampaignSummaryPaginatedResponse.ts new file mode 100644 index 00000000..cd4b8a65 --- /dev/null +++ b/src/api/types/CampaignSummaryPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CampaignSummaryPaginatedResponse { + results: Vapi.CampaignSummary[]; + metadata: Vapi.PaginationMeta; +} diff --git a/src/api/types/CampaignSummaryServerMessagesItem.ts b/src/api/types/CampaignSummaryServerMessagesItem.ts new file mode 100644 index 00000000..ac8f4360 --- /dev/null +++ b/src/api/types/CampaignSummaryServerMessagesItem.ts @@ -0,0 +1,17 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CampaignSummaryServerMessagesItem = { + CampaignStarted: "campaign.started", + CampaignCancelled: "campaign.cancelled", + CampaignEnded: "campaign.ended", + CampaignArchived: "campaign.archived", + CampaignUnarchived: "campaign.unarchived", + ContactDispatched: "contact.dispatched", + ContactCompleted: "contact.completed", + ContactFailed: "contact.failed", + ContactSkipped: "contact.skipped", + ContactPredialFailed: "contact.predial-failed", + CampaignJobContinued: "campaign.job.continued", +} as const; +export type CampaignSummaryServerMessagesItem = + (typeof CampaignSummaryServerMessagesItem)[keyof typeof CampaignSummaryServerMessagesItem]; diff --git a/src/api/types/CampaignSummaryStatus.ts b/src/api/types/CampaignSummaryStatus.ts new file mode 100644 index 00000000..d0a80bb7 --- /dev/null +++ b/src/api/types/CampaignSummaryStatus.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the status of the campaign. */ +export const CampaignSummaryStatus = { + Scheduled: "scheduled", + InProgress: "in-progress", + Ended: "ended", + Cancelled: "cancelled", + Archived: "archived", +} as const; +export type CampaignSummaryStatus = (typeof CampaignSummaryStatus)[keyof typeof CampaignSummaryStatus]; diff --git a/src/api/types/CartesiaCredential.ts b/src/api/types/CartesiaCredential.ts index 7dbe4c9f..eef6ad89 100644 --- a/src/api/types/CartesiaCredential.ts +++ b/src/api/types/CartesiaCredential.ts @@ -16,4 +16,6 @@ export interface CartesiaCredential { updatedAt: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; + /** This can be used to point to an onprem Cartesia instance. Defaults to api.cartesia.ai. */ + apiUrl?: string | undefined; } diff --git a/src/api/types/CartesiaExperimentalControls.ts b/src/api/types/CartesiaExperimentalControls.ts index 90cdef79..a43f8b64 100644 --- a/src/api/types/CartesiaExperimentalControls.ts +++ b/src/api/types/CartesiaExperimentalControls.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Cartesia voice controls for speed and emotion. + */ export interface CartesiaExperimentalControls { + /** Speaking-speed control expressed as a preset or a value from -1 to 1. */ speed?: Vapi.CartesiaSpeedControl | undefined; + /** Emotion and intensity applied to the Cartesia voice. */ emotion?: Vapi.CartesiaExperimentalControlsEmotion | undefined; } diff --git a/src/api/types/CartesiaExperimentalControlsEmotion.ts b/src/api/types/CartesiaExperimentalControlsEmotion.ts index 50e0ecd3..74c62d28 100644 --- a/src/api/types/CartesiaExperimentalControlsEmotion.ts +++ b/src/api/types/CartesiaExperimentalControlsEmotion.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Emotion and intensity applied to the Cartesia voice. */ export const CartesiaExperimentalControlsEmotion = { AngerLowest: "anger:lowest", AngerLow: "anger:low", diff --git a/src/api/types/CartesiaGenerationConfig.ts b/src/api/types/CartesiaGenerationConfig.ts index ed93001a..01b66a8b 100644 --- a/src/api/types/CartesiaGenerationConfig.ts +++ b/src/api/types/CartesiaGenerationConfig.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization. + */ export interface CartesiaGenerationConfig { /** Fine-grained speed control for sonic-3. Only available for sonic-3 model. */ speed?: number | undefined; diff --git a/src/api/types/CartesiaGenerationConfigExperimental.ts b/src/api/types/CartesiaGenerationConfigExperimental.ts index 4d1a4a3f..304eb00f 100644 --- a/src/api/types/CartesiaGenerationConfigExperimental.ts +++ b/src/api/types/CartesiaGenerationConfigExperimental.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Cartesia Sonic 3 generation controls, including accent localization. + */ export interface CartesiaGenerationConfigExperimental { /** Toggle accent localization for sonic-3: 0 (disabled, default) or 1 (enabled). When enabled, the voice adapts to match the transcript language accent while preserving vocal characteristics. */ accentLocalization?: number | undefined; diff --git a/src/api/types/CartesiaSpeedControl.ts b/src/api/types/CartesiaSpeedControl.ts index acaee582..7857983b 100644 --- a/src/api/types/CartesiaSpeedControl.ts +++ b/src/api/types/CartesiaSpeedControl.ts @@ -2,4 +2,7 @@ import type * as Vapi from "../index.js"; +/** + * Speaking-speed control expressed as a preset or a value from -1 to 1. + */ export type CartesiaSpeedControl = Vapi.CartesiaSpeedControlZero | number; diff --git a/src/api/types/CartesiaTranscriber.ts b/src/api/types/CartesiaTranscriber.ts index f95def21..09a08b04 100644 --- a/src/api/types/CartesiaTranscriber.ts +++ b/src/api/types/CartesiaTranscriber.ts @@ -2,8 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and fallback settings. + */ export interface CartesiaTranscriber { + /** The Cartesia speech-to-text model used for transcription. */ model?: Vapi.CartesiaTranscriberModel | undefined; + /** The language code used for transcription. */ language?: Vapi.CartesiaTranscriberLanguage | undefined; /** This is the plan for transcriber provider fallbacks in the event that the primary transcriber provider fails. */ fallbackPlan?: Vapi.FallbackTranscriberPlan | undefined; diff --git a/src/api/types/CartesiaTranscriberLanguage.ts b/src/api/types/CartesiaTranscriberLanguage.ts index 439cc84e..cbb85d59 100644 --- a/src/api/types/CartesiaTranscriberLanguage.ts +++ b/src/api/types/CartesiaTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The language code used for transcription. */ export const CartesiaTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/CartesiaTranscriberModel.ts b/src/api/types/CartesiaTranscriberModel.ts index 031175c5..bd23bbcf 100644 --- a/src/api/types/CartesiaTranscriberModel.ts +++ b/src/api/types/CartesiaTranscriberModel.ts @@ -1,6 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** The Cartesia speech-to-text model used for transcription. */ export const CartesiaTranscriberModel = { InkWhisper: "ink-whisper", + Ink2: "ink-2", } as const; export type CartesiaTranscriberModel = (typeof CartesiaTranscriberModel)[keyof typeof CartesiaTranscriberModel]; diff --git a/src/api/types/CartesiaVoice.ts b/src/api/types/CartesiaVoice.ts index 0c31ea83..2ab9abfa 100644 --- a/src/api/types/CartesiaVoice.ts +++ b/src/api/types/CartesiaVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, caching, and fallback settings. + */ export interface CartesiaVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/CartesiaVoiceModel.ts b/src/api/types/CartesiaVoiceModel.ts index fc18936e..94b8dc3d 100644 --- a/src/api/types/CartesiaVoiceModel.ts +++ b/src/api/types/CartesiaVoiceModel.ts @@ -2,6 +2,8 @@ /** This is the model that will be used. This is optional and will default to the correct model for the voiceId. */ export const CartesiaVoiceModel = { + Sonic35: "sonic-3.5", + Sonic3520260504: "sonic-3.5-2026-05-04", Sonic3: "sonic-3", Sonic320260112: "sonic-3-2026-01-12", Sonic320251027: "sonic-3-2025-10-27", diff --git a/src/api/types/CerebrasModel.ts b/src/api/types/CerebrasModel.ts index cb48fbcd..753e503c 100644 --- a/src/api/types/CerebrasModel.ts +++ b/src/api/types/CerebrasModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface CerebrasModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface CerebrasModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.CerebrasModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/CerebrasModelToolsItem.ts b/src/api/types/CerebrasModelToolsItem.ts index 47a300b0..77c68ea5 100644 --- a/src/api/types/CerebrasModelToolsItem.ts +++ b/src/api/types/CerebrasModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace CerebrasModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.CerebrasModelToolsItem.ApiRequest + | Vapi.CerebrasModelToolsItem.Bash + | Vapi.CerebrasModelToolsItem.Code + | Vapi.CerebrasModelToolsItem.Computer + | Vapi.CerebrasModelToolsItem.Dtmf + | Vapi.CerebrasModelToolsItem.EndCall + | Vapi.CerebrasModelToolsItem.Function + | Vapi.CerebrasModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.CerebrasModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.CerebrasModelToolsItem.GohighlevelContactCreate + | Vapi.CerebrasModelToolsItem.GohighlevelContactGet + | Vapi.CerebrasModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.CerebrasModelToolsItem.GoogleCalendarEventCreate + | Vapi.CerebrasModelToolsItem.GoogleSheetsRowAppend + | Vapi.CerebrasModelToolsItem.Handoff + | Vapi.CerebrasModelToolsItem.Mcp + | Vapi.CerebrasModelToolsItem.Query + | Vapi.CerebrasModelToolsItem.SlackMessageSend + | Vapi.CerebrasModelToolsItem.Sms + | Vapi.CerebrasModelToolsItem.TextEditor + | Vapi.CerebrasModelToolsItem.TransferCall + | Vapi.CerebrasModelToolsItem.SipRequest + | Vapi.CerebrasModelToolsItem.Voicemail; } diff --git a/src/api/types/ChatEvalAssistantMessageEvaluation.ts b/src/api/types/ChatEvalAssistantMessageEvaluation.ts index 7251f430..2e9db6f1 100644 --- a/src/api/types/ChatEvalAssistantMessageEvaluation.ts +++ b/src/api/types/ChatEvalAssistantMessageEvaluation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue afterward. + */ export interface ChatEvalAssistantMessageEvaluation { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalAssistantMessageMock.ts b/src/api/types/ChatEvalAssistantMessageMock.ts index 65aae701..6e96c11e 100644 --- a/src/api/types/ChatEvalAssistantMessageMock.ts +++ b/src/api/types/ChatEvalAssistantMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated assistant turn in an evaluation conversation, with optional message content and tool calls. + */ export interface ChatEvalAssistantMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalAssistantMessageMockToolCall.ts b/src/api/types/ChatEvalAssistantMessageMockToolCall.ts index 247946c3..875435ed 100644 --- a/src/api/types/ChatEvalAssistantMessageMockToolCall.ts +++ b/src/api/types/ChatEvalAssistantMessageMockToolCall.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A simulated assistant tool call with the tool name and optional arguments. + */ export interface ChatEvalAssistantMessageMockToolCall { /** * This is the name of the tool that will be called. diff --git a/src/api/types/ChatEvalSystemMessageMock.ts b/src/api/types/ChatEvalSystemMessageMock.ts index 4af1e411..ded983ac 100644 --- a/src/api/types/ChatEvalSystemMessageMock.ts +++ b/src/api/types/ChatEvalSystemMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated system message in an evaluation conversation. + */ export interface ChatEvalSystemMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalToolResponseMessageEvaluation.ts b/src/api/types/ChatEvalToolResponseMessageEvaluation.ts index cdbfead3..74b1beac 100644 --- a/src/api/types/ChatEvalToolResponseMessageEvaluation.ts +++ b/src/api/types/ChatEvalToolResponseMessageEvaluation.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An expected tool-response turn evaluated by a configured LLM judge. + */ export interface ChatEvalToolResponseMessageEvaluation { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalToolResponseMessageMock.ts b/src/api/types/ChatEvalToolResponseMessageMock.ts index 9f998645..feeeed9a 100644 --- a/src/api/types/ChatEvalToolResponseMessageMock.ts +++ b/src/api/types/ChatEvalToolResponseMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated tool response in an evaluation conversation. + */ export interface ChatEvalToolResponseMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChatEvalUserMessageMock.ts b/src/api/types/ChatEvalUserMessageMock.ts index 5639fc6c..896f52b8 100644 --- a/src/api/types/ChatEvalUserMessageMock.ts +++ b/src/api/types/ChatEvalUserMessageMock.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A simulated user message in an evaluation conversation. + */ export interface ChatEvalUserMessageMock { /** * This is the role of the message author. diff --git a/src/api/types/ChunkPlan.ts b/src/api/types/ChunkPlan.ts index 9ec75b8f..e5fac399 100644 --- a/src/api/types/ChunkPlan.ts +++ b/src/api/types/ChunkPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation boundaries, and formatting. + */ export interface ChunkPlan { /** * This determines whether the model output is chunked before being sent to the voice provider. Default `true`. diff --git a/src/api/types/ClientMessageAssistantSpeech.ts b/src/api/types/ClientMessageAssistantSpeech.ts index aeb1c36f..6e5ef12b 100644 --- a/src/api/types/ClientMessageAssistantSpeech.ts +++ b/src/api/types/ClientMessageAssistantSpeech.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageAssistantSpeech { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageAssistantSpeechPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "assistant-speech" is sent as assistant audio is being played. */ type: Vapi.ClientMessageAssistantSpeechType; /** diff --git a/src/api/types/ClientMessageAssistantStarted.ts b/src/api/types/ClientMessageAssistantStarted.ts index da70f9b2..7c2128ab 100644 --- a/src/api/types/ClientMessageAssistantStarted.ts +++ b/src/api/types/ClientMessageAssistantStarted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageAssistantStarted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageAssistantStartedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "assistant.started" is sent when the assistant is started. */ type: Vapi.ClientMessageAssistantStartedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageCallDeleteFailed.ts b/src/api/types/ClientMessageCallDeleteFailed.ts index a51d6357..6725fa2c 100644 --- a/src/api/types/ClientMessageCallDeleteFailed.ts +++ b/src/api/types/ClientMessageCallDeleteFailed.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageCallDeleteFailed { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageCallDeleteFailedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "call.deleted" is sent when a call is deleted. */ type: Vapi.ClientMessageCallDeleteFailedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageCallDeleted.ts b/src/api/types/ClientMessageCallDeleted.ts index a59ef6bb..b8872052 100644 --- a/src/api/types/ClientMessageCallDeleted.ts +++ b/src/api/types/ClientMessageCallDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageCallDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageCallDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "call.deleted" is sent when a call is deleted. */ type: Vapi.ClientMessageCallDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageChatCreated.ts b/src/api/types/ClientMessageChatCreated.ts index e204f16b..41f1674e 100644 --- a/src/api/types/ClientMessageChatCreated.ts +++ b/src/api/types/ClientMessageChatCreated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageChatCreated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageChatCreatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "chat.created" is sent when a new chat is created. */ type: Vapi.ClientMessageChatCreatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageChatDeleted.ts b/src/api/types/ClientMessageChatDeleted.ts index 34b28f4d..2904ca83 100644 --- a/src/api/types/ClientMessageChatDeleted.ts +++ b/src/api/types/ClientMessageChatDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageChatDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageChatDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "chat.deleted" is sent when a chat is deleted. */ type: Vapi.ClientMessageChatDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageConversationUpdate.ts b/src/api/types/ClientMessageConversationUpdate.ts index d2bd6484..0079dda9 100644 --- a/src/api/types/ClientMessageConversationUpdate.ts +++ b/src/api/types/ClientMessageConversationUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageConversationUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageConversationUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "conversation-update" is sent when an update is committed to the conversation history. */ type: Vapi.ClientMessageConversationUpdateType; /** This is the most up-to-date conversation history at the time the message is sent. */ diff --git a/src/api/types/ClientMessageHang.ts b/src/api/types/ClientMessageHang.ts index 5cfecf25..b64f6124 100644 --- a/src/api/types/ClientMessageHang.ts +++ b/src/api/types/ClientMessageHang.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageHang { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageHangPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** * This is the type of the message. "hang" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as: * - the model is too slow to respond diff --git a/src/api/types/ClientMessageLanguageChangeDetected.ts b/src/api/types/ClientMessageLanguageChangeDetected.ts index e9724a68..ce3f0f18 100644 --- a/src/api/types/ClientMessageLanguageChangeDetected.ts +++ b/src/api/types/ClientMessageLanguageChangeDetected.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageLanguageChangeDetected { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageLanguageChangeDetectedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "language-change-detected" is sent when the transcriber is automatically switched based on the detected language. */ type: Vapi.ClientMessageLanguageChangeDetectedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageMetadata.ts b/src/api/types/ClientMessageMetadata.ts index 4c0c6ca1..65510dae 100644 --- a/src/api/types/ClientMessageMetadata.ts +++ b/src/api/types/ClientMessageMetadata.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageMetadata { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageMetadataPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "metadata" is sent to forward metadata to the client. */ type: Vapi.ClientMessageMetadataType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageModelOutput.ts b/src/api/types/ClientMessageModelOutput.ts index 4dd12ce4..5dfe7d1b 100644 --- a/src/api/types/ClientMessageModelOutput.ts +++ b/src/api/types/ClientMessageModelOutput.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageModelOutput { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageModelOutputPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "model-output" is sent as the model outputs tokens. */ type: Vapi.ClientMessageModelOutputType; /** diff --git a/src/api/types/ClientMessageSessionCreated.ts b/src/api/types/ClientMessageSessionCreated.ts index a2198c57..0112d76b 100644 --- a/src/api/types/ClientMessageSessionCreated.ts +++ b/src/api/types/ClientMessageSessionCreated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageSessionCreated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageSessionCreatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.created" is sent when a new session is created. */ type: Vapi.ClientMessageSessionCreatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageSessionDeleted.ts b/src/api/types/ClientMessageSessionDeleted.ts index 4879e2e3..787d63fd 100644 --- a/src/api/types/ClientMessageSessionDeleted.ts +++ b/src/api/types/ClientMessageSessionDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageSessionDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageSessionDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.deleted" is sent when a session is deleted. */ type: Vapi.ClientMessageSessionDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageSessionUpdated.ts b/src/api/types/ClientMessageSessionUpdated.ts index a3005cf0..0c425259 100644 --- a/src/api/types/ClientMessageSessionUpdated.ts +++ b/src/api/types/ClientMessageSessionUpdated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageSessionUpdated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageSessionUpdatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.updated" is sent when a session is updated. */ type: Vapi.ClientMessageSessionUpdatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageSpeechUpdate.ts b/src/api/types/ClientMessageSpeechUpdate.ts index fdafdcdf..4d0a02ea 100644 --- a/src/api/types/ClientMessageSpeechUpdate.ts +++ b/src/api/types/ClientMessageSpeechUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageSpeechUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageSpeechUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "speech-update" is sent whenever assistant or user start or stop speaking. */ type: Vapi.ClientMessageSpeechUpdateType; /** This is the status of the speech update. */ diff --git a/src/api/types/ClientMessageToolCalls.ts b/src/api/types/ClientMessageToolCalls.ts index cb6b7b34..d993698e 100644 --- a/src/api/types/ClientMessageToolCalls.ts +++ b/src/api/types/ClientMessageToolCalls.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageToolCalls { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageToolCallsPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "tool-calls" is sent to call a tool. */ type?: Vapi.ClientMessageToolCallsType | undefined; /** This is the list of tools calls that the model is requesting along with the original tool configuration. */ diff --git a/src/api/types/ClientMessageToolCallsResult.ts b/src/api/types/ClientMessageToolCallsResult.ts index 49429de0..1872a6ed 100644 --- a/src/api/types/ClientMessageToolCallsResult.ts +++ b/src/api/types/ClientMessageToolCallsResult.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageToolCallsResult { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageToolCallsResultPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "tool-calls-result" is sent to forward the result of a tool call to the client. */ type: Vapi.ClientMessageToolCallsResultType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageTranscript.ts b/src/api/types/ClientMessageTranscript.ts index 73258131..0bcc638f 100644 --- a/src/api/types/ClientMessageTranscript.ts +++ b/src/api/types/ClientMessageTranscript.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageTranscript { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageTranscriptPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "transcript" is sent as transcriber outputs partial or final transcript. */ type: Vapi.ClientMessageTranscriptType; /** This is the timestamp of the message. */ @@ -21,6 +28,16 @@ export interface ClientMessageTranscript { transcriptType: Vapi.ClientMessageTranscriptTranscriptType; /** This is the transcript content. */ transcript: string; + /** + * The ID of the assistant that produced this transcript. Present on + * assistant-role events when an active assistant ID is available. + */ + assistantId?: string | undefined; + /** + * The name of the assistant that produced this transcript. Present on + * assistant-role events when an active assistant name is available. + */ + assistantName?: string | undefined; /** Indicates if the transcript was filtered for security reasons. */ isFiltered?: boolean | undefined; /** List of detected security threats if the transcript was filtered. */ diff --git a/src/api/types/ClientMessageTransferUpdate.ts b/src/api/types/ClientMessageTransferUpdate.ts index a8b69780..cdabc7fd 100644 --- a/src/api/types/ClientMessageTransferUpdate.ts +++ b/src/api/types/ClientMessageTransferUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageTransferUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageTransferUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "transfer-update" is sent whenever a transfer happens. */ type: Vapi.ClientMessageTransferUpdateType; /** This is the destination of the transfer. */ diff --git a/src/api/types/ClientMessageUserInterrupted.ts b/src/api/types/ClientMessageUserInterrupted.ts index 2781040e..ff558eaa 100644 --- a/src/api/types/ClientMessageUserInterrupted.ts +++ b/src/api/types/ClientMessageUserInterrupted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageUserInterrupted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageUserInterruptedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "user-interrupted" is sent when the user interrupts the assistant. */ type: Vapi.ClientMessageUserInterruptedType; /** diff --git a/src/api/types/ClientMessageVoiceInput.ts b/src/api/types/ClientMessageVoiceInput.ts index c8c44d74..2d3b2520 100644 --- a/src/api/types/ClientMessageVoiceInput.ts +++ b/src/api/types/ClientMessageVoiceInput.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageVoiceInput { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageVoiceInputPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "voice-input" is sent when a generation is requested from voice provider. */ type: Vapi.ClientMessageVoiceInputType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ClientMessageWorkflowNodeStarted.ts b/src/api/types/ClientMessageWorkflowNodeStarted.ts index beb4c177..40ad543f 100644 --- a/src/api/types/ClientMessageWorkflowNodeStarted.ts +++ b/src/api/types/ClientMessageWorkflowNodeStarted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ClientMessageWorkflowNodeStarted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ClientMessageWorkflowNodeStartedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "workflow.node.started" is sent when the active node changes. */ type: Vapi.ClientMessageWorkflowNodeStartedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/CloudflareR2BucketPlan.ts b/src/api/types/CloudflareR2BucketPlan.ts index 72dfada2..1f276a2d 100644 --- a/src/api/types/CloudflareR2BucketPlan.ts +++ b/src/api/types/CloudflareR2BucketPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and path. + */ export interface CloudflareR2BucketPlan { /** Cloudflare R2 Access key ID. */ accessKeyId?: string | undefined; diff --git a/src/api/types/CodeTool.ts b/src/api/types/CodeTool.ts index 8736f172..c1d9ee1d 100644 --- a/src/api/types/CodeTool.ts +++ b/src/api/types/CodeTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ export interface CodeTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CodeToolMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/CodeToolEnvironmentVariable.ts b/src/api/types/CodeToolEnvironmentVariable.ts index 75f78883..ccfd862b 100644 --- a/src/api/types/CodeToolEnvironmentVariable.ts +++ b/src/api/types/CodeToolEnvironmentVariable.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An environment variable supplied to code-tool execution, with support for Liquid templates in its value. + */ export interface CodeToolEnvironmentVariable { /** Name of the environment variable */ name: string; diff --git a/src/api/types/Compliance.ts b/src/api/types/Compliance.ts index ae8ea4ed..bcef4ba6 100644 --- a/src/api/types/Compliance.ts +++ b/src/api/types/Compliance.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Compliance information captured for a call, including recording consent. + */ export interface Compliance { /** This is the recording consent of the call. Configure in `assistant.compliancePlan.recordingConsentPlan`. */ recordingConsent?: Vapi.RecordingConsent | undefined; diff --git a/src/api/types/ComplianceOverride.ts b/src/api/types/ComplianceOverride.ts index 941b3635..e800dd0e 100644 --- a/src/api/types/ComplianceOverride.ts +++ b/src/api/types/ComplianceOverride.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Overrides storage behavior for an output when HIPAA compliance is enabled. + */ export interface ComplianceOverride { /** Force storage for this output under HIPAA. Only enable if output contains no sensitive data. */ forceStoreOnHipaaEnabled?: boolean | undefined; diff --git a/src/api/types/CompliancePlan.ts b/src/api/types/CompliancePlan.ts index aff989ce..3d0eff1d 100644 --- a/src/api/types/CompliancePlan.ts +++ b/src/api/types/CompliancePlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant calls. + */ export interface CompliancePlan { /** When this is enabled, logs, recordings, and transcriptions will be stored in HIPAA-compliant storage. Defaults to false. Only HIPAA-compliant providers will be available for LLM, Voice, and Transcriber respectively. This setting is only honored if the organization is on an Enterprise subscription or has purchased the HIPAA add-on. */ hipaaEnabled?: boolean | undefined; @@ -12,5 +15,6 @@ export interface CompliancePlan { pciEnabled?: boolean | undefined; /** This is the security filter plan for the assistant. It allows filtering of transcripts for security threats before sending to LLM. */ securityFilterPlan?: Vapi.SecurityFilterPlan | undefined; + /** Controls how recording consent is requested before the assistant joins the call. */ recordingConsentPlan?: Vapi.CompliancePlanRecordingConsentPlan | undefined; } diff --git a/src/api/types/CompliancePlanRecordingConsentPlan.ts b/src/api/types/CompliancePlanRecordingConsentPlan.ts index b186b48a..a8195fe8 100644 --- a/src/api/types/CompliancePlanRecordingConsentPlan.ts +++ b/src/api/types/CompliancePlanRecordingConsentPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how recording consent is requested before the assistant joins the call. + */ export type CompliancePlanRecordingConsentPlan = | Vapi.CompliancePlanRecordingConsentPlan.StayOnLine | Vapi.CompliancePlanRecordingConsentPlan.Verbal; diff --git a/src/api/types/ComputerTool.ts b/src/api/types/ComputerTool.ts index 19f18a15..df28ec05 100644 --- a/src/api/types/ComputerTool.ts +++ b/src/api/types/ComputerTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ export interface ComputerTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.ComputerToolMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.ComputerToolSubType; diff --git a/src/api/types/ComputerToolWithToolCall.ts b/src/api/types/ComputerToolWithToolCall.ts index ba2afa14..203030d3 100644 --- a/src/api/types/ComputerToolWithToolCall.ts +++ b/src/api/types/ComputerToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface ComputerToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.ComputerToolWithToolCallMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.ComputerToolWithToolCallSubType; diff --git a/src/api/types/Condition.ts b/src/api/types/Condition.ts index 66d1d180..5312322c 100644 --- a/src/api/types/Condition.ts +++ b/src/api/types/Condition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Compares a named parameter with a value using the selected comparison operator. + */ export interface Condition { /** This is the operator you want to use to compare the parameter and value. */ operator: Vapi.ConditionOperator; diff --git a/src/api/types/ContextEngineeringPlanAll.ts b/src/api/types/ContextEngineeringPlanAll.ts index 7ed31385..682818b6 100644 --- a/src/api/types/ContextEngineeringPlanAll.ts +++ b/src/api/types/ContextEngineeringPlanAll.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes all available messages when constructing context for a handoff. + */ export type ContextEngineeringPlanAll = {}; diff --git a/src/api/types/ContextEngineeringPlanLastNMessages.ts b/src/api/types/ContextEngineeringPlanLastNMessages.ts index d03df6bf..71ac3e14 100644 --- a/src/api/types/ContextEngineeringPlanLastNMessages.ts +++ b/src/api/types/ContextEngineeringPlanLastNMessages.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes a configured number of the most recent messages when constructing context for a handoff. + */ export interface ContextEngineeringPlanLastNMessages { /** This is the maximum number of messages to include in the context engineering plan. */ maxMessages: number; diff --git a/src/api/types/ContextEngineeringPlanNone.ts b/src/api/types/ContextEngineeringPlanNone.ts index efd7c1f4..88e23076 100644 --- a/src/api/types/ContextEngineeringPlanNone.ts +++ b/src/api/types/ContextEngineeringPlanNone.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Excludes prior conversation messages when constructing context for a handoff. + */ export type ContextEngineeringPlanNone = {}; diff --git a/src/api/types/ContextEngineeringPlanPreviousAssistantMessages.ts b/src/api/types/ContextEngineeringPlanPreviousAssistantMessages.ts new file mode 100644 index 00000000..0996a060 --- /dev/null +++ b/src/api/types/ContextEngineeringPlanPreviousAssistantMessages.ts @@ -0,0 +1,3 @@ +// This file was auto-generated by Fern from our API Definition. + +export type ContextEngineeringPlanPreviousAssistantMessages = {}; diff --git a/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts b/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts index bc4cddbc..1343b439 100644 --- a/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts +++ b/src/api/types/ContextEngineeringPlanUserAndAssistantMessages.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Includes only user and assistant messages when constructing context for a handoff. + */ export type ContextEngineeringPlanUserAndAssistantMessages = {}; diff --git a/src/api/types/ConversationNode.ts b/src/api/types/ConversationNode.ts index 1bc05e74..c8bd3926 100644 --- a/src/api/types/ConversationNode.ts +++ b/src/api/types/ConversationNode.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, and variable extraction. + */ export interface ConversationNode { /** * This is the model for the node. @@ -33,6 +36,7 @@ export interface ConversationNode { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** Prompt that guides the assistant while this node is active. */ prompt?: string | undefined; /** This is the plan for the global node. */ globalNodePlan?: Vapi.GlobalNodePlan | undefined; @@ -86,6 +90,7 @@ export interface ConversationNode { * Note: The `schema` field is required for Conversation nodes if you want to extract variables from the user's responses. `aliases` is just a convenience. */ variableExtractionPlan?: Vapi.VariableExtractionPlan | undefined; + /** Unique name used to identify this workflow node. */ name: string; /** This is whether or not the node is the start of the workflow. */ isStart?: boolean | undefined; diff --git a/src/api/types/ConversationNodeToolsItem.ts b/src/api/types/ConversationNodeToolsItem.ts index 128f6cc3..0798d658 100644 --- a/src/api/types/ConversationNodeToolsItem.ts +++ b/src/api/types/ConversationNodeToolsItem.ts @@ -119,4 +119,29 @@ export namespace ConversationNodeToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.ConversationNodeToolsItem.ApiRequest + | Vapi.ConversationNodeToolsItem.Bash + | Vapi.ConversationNodeToolsItem.Code + | Vapi.ConversationNodeToolsItem.Computer + | Vapi.ConversationNodeToolsItem.Dtmf + | Vapi.ConversationNodeToolsItem.EndCall + | Vapi.ConversationNodeToolsItem.Function + | Vapi.ConversationNodeToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.ConversationNodeToolsItem.GohighlevelCalendarEventCreate + | Vapi.ConversationNodeToolsItem.GohighlevelContactCreate + | Vapi.ConversationNodeToolsItem.GohighlevelContactGet + | Vapi.ConversationNodeToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.ConversationNodeToolsItem.GoogleCalendarEventCreate + | Vapi.ConversationNodeToolsItem.GoogleSheetsRowAppend + | Vapi.ConversationNodeToolsItem.Handoff + | Vapi.ConversationNodeToolsItem.Mcp + | Vapi.ConversationNodeToolsItem.Query + | Vapi.ConversationNodeToolsItem.SlackMessageSend + | Vapi.ConversationNodeToolsItem.Sms + | Vapi.ConversationNodeToolsItem.TextEditor + | Vapi.ConversationNodeToolsItem.TransferCall + | Vapi.ConversationNodeToolsItem.SipRequest + | Vapi.ConversationNodeToolsItem.Voicemail; } diff --git a/src/api/types/ConversationNodeTranscriber.ts b/src/api/types/ConversationNodeTranscriber.ts index 3bd5ffca..3d048b76 100644 --- a/src/api/types/ConversationNodeTranscriber.ts +++ b/src/api/types/ConversationNodeTranscriber.ts @@ -19,7 +19,9 @@ export type ConversationNodeTranscriber = | Vapi.ConversationNodeTranscriber.Talkscriber | Vapi.ConversationNodeTranscriber.Openai | Vapi.ConversationNodeTranscriber.Cartesia - | Vapi.ConversationNodeTranscriber.Soniox; + | Vapi.ConversationNodeTranscriber.Soniox + | Vapi.ConversationNodeTranscriber.Xai + | Vapi.ConversationNodeTranscriber.Vapi; export namespace ConversationNodeTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -69,4 +71,12 @@ export namespace ConversationNodeTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/ConversationNodeVoice.ts b/src/api/types/ConversationNodeVoice.ts index 52a1b44e..feb7ad91 100644 --- a/src/api/types/ConversationNodeVoice.ts +++ b/src/api/types/ConversationNodeVoice.ts @@ -25,7 +25,9 @@ export type ConversationNodeVoice = | Vapi.ConversationNodeVoice.Vapi | Vapi.ConversationNodeVoice.Sesame | Vapi.ConversationNodeVoice.Inworld - | Vapi.ConversationNodeVoice.Minimax; + | Vapi.ConversationNodeVoice.Minimax + | Vapi.ConversationNodeVoice.Xai + | Vapi.ConversationNodeVoice.Microsoft; export namespace ConversationNodeVoice { export interface Azure extends Vapi.AzureVoice { @@ -99,4 +101,12 @@ export namespace ConversationNodeVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/CostBreakdown.ts b/src/api/types/CostBreakdown.ts index 9f9e469b..586813d4 100644 --- a/src/api/types/CostBreakdown.ts +++ b/src/api/types/CostBreakdown.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and character totals. + */ export interface CostBreakdown { /** This is the cost of the transport provider, like Twilio or Vonage. */ transport?: number | undefined; diff --git a/src/api/types/CreateAnthropicBedrockCredentialDto.ts b/src/api/types/CreateAnthropicBedrockCredentialDto.ts index 47cb1b3e..42e886e1 100644 --- a/src/api/types/CreateAnthropicBedrockCredentialDto.ts +++ b/src/api/types/CreateAnthropicBedrockCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and authentication method. + */ export interface CreateAnthropicBedrockCredentialDto { /** AWS region where Bedrock is configured. */ region: Vapi.CreateAnthropicBedrockCredentialDtoRegion; diff --git a/src/api/types/CreateAnthropicBedrockCredentialDtoRegion.ts b/src/api/types/CreateAnthropicBedrockCredentialDtoRegion.ts index b92ed783..a74361c0 100644 --- a/src/api/types/CreateAnthropicBedrockCredentialDtoRegion.ts +++ b/src/api/types/CreateAnthropicBedrockCredentialDtoRegion.ts @@ -4,6 +4,7 @@ export const CreateAnthropicBedrockCredentialDtoRegion = { UsEast1: "us-east-1", UsWest2: "us-west-2", + EuCentral1: "eu-central-1", EuWest1: "eu-west-1", EuWest3: "eu-west-3", ApNortheast1: "ap-northeast-1", diff --git a/src/api/types/CreateAnthropicCredentialDto.ts b/src/api/types/CreateAnthropicCredentialDto.ts index f2f7c470..5c377968 100644 --- a/src/api/types/CreateAnthropicCredentialDto.ts +++ b/src/api/types/CreateAnthropicCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Anthropic. + */ export interface CreateAnthropicCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateAnyscaleCredentialDto.ts b/src/api/types/CreateAnyscaleCredentialDto.ts index af1d780d..ce630bd3 100644 --- a/src/api/types/CreateAnyscaleCredentialDto.ts +++ b/src/api/types/CreateAnyscaleCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Anyscale. + */ export interface CreateAnyscaleCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateApiRequestToolDto.ts b/src/api/types/CreateApiRequestToolDto.ts index 1e524283..a56ead07 100644 --- a/src/api/types/CreateApiRequestToolDto.ts +++ b/src/api/types/CreateApiRequestToolDto.ts @@ -2,13 +2,19 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ export interface CreateApiRequestToolDto { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.CreateApiRequestToolDtoMessagesItem[] | undefined; /** - * These are the messages that will be spoken to the user as the tool is running. + * This is the name of the tool. This will be passed to the model. * - * 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. + * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40. */ - messages?: Vapi.CreateApiRequestToolDtoMessagesItem[] | undefined; + name?: string | undefined; + /** The HTTP method used for the API request. */ method: Vapi.CreateApiRequestToolDtoMethod; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. @@ -22,12 +28,6 @@ export interface CreateApiRequestToolDto { encryptedPaths?: string[] | undefined; /** Static key-value pairs merged into the request body. Values support Liquid templates. */ parameters?: Vapi.ToolParameter[] | undefined; - /** - * 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. - */ - name?: string | undefined; /** This is the description of the tool. This will be passed to the model. */ description?: string | undefined; /** This is where the request will be sent. */ diff --git a/src/api/types/CreateApiRequestToolDtoMethod.ts b/src/api/types/CreateApiRequestToolDtoMethod.ts index f9a682c5..15c52325 100644 --- a/src/api/types/CreateApiRequestToolDtoMethod.ts +++ b/src/api/types/CreateApiRequestToolDtoMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const CreateApiRequestToolDtoMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/CreateAssemblyAiCredentialDto.ts b/src/api/types/CreateAssemblyAiCredentialDto.ts index e03c9866..ef25dcb7 100644 --- a/src/api/types/CreateAssemblyAiCredentialDto.ts +++ b/src/api/types/CreateAssemblyAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with AssemblyAI. + */ export interface CreateAssemblyAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateAssistantDraftDto.ts b/src/api/types/CreateAssistantDraftDto.ts new file mode 100644 index 00000000..32c267d5 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDto.ts @@ -0,0 +1,159 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CreateAssistantDraftDto { + /** These are the options for the assistant's transcriber. */ + transcriber?: Vapi.CreateAssistantDraftDtoTranscriber | undefined; + /** These are the options for the assistant's LLM. */ + model?: Vapi.CreateAssistantDraftDtoModel | undefined; + /** These are the options for the assistant's voice. */ + voice?: Vapi.CreateAssistantDraftDtoVoice | undefined; + /** + * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). + * + * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. + */ + firstMessage?: string | undefined; + firstMessageInterruptionsEnabled?: boolean | undefined; + /** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.CreateAssistantDraftDtoFirstMessageMode | undefined; + /** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ + voicemailDetection?: Vapi.CreateAssistantDraftDtoVoicemailDetection | undefined; + /** These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema. */ + clientMessages?: Vapi.CreateAssistantDraftDtoClientMessagesItem[] | undefined; + /** These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema. */ + serverMessages?: Vapi.CreateAssistantDraftDtoServerMessagesItem[] | undefined; + /** + * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. + * + * @default 600 (10 minutes) + */ + maxDurationSeconds?: number | undefined; + /** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ + backgroundSound?: Vapi.CreateAssistantDraftDtoBackgroundSound | undefined; + /** + * This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. + * + * @default false + */ + modelOutputInMessagesEnabled?: boolean | undefined; + /** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */ + transportConfigurations?: Vapi.TransportConfigurationTwilio[] | undefined; + /** + * This is the plan for observability of assistant's calls. + * + * Currently, only Langfuse is supported. + */ + observabilityPlan?: Vapi.LangfuseObservabilityPlan | undefined; + /** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */ + credentials?: Vapi.CreateAssistantDraftDtoCredentialsItem[] | undefined; + /** This is a set of actions that will be performed on certain events. */ + hooks?: Vapi.CreateAssistantDraftDtoHooksItem[] | undefined; + /** + * This is the name of the assistant. + * + * This is required when you want to transfer between assistants in a call. + */ + name?: string | undefined; + /** + * This is the message that the assistant will say if the call is forwarded to voicemail. + * + * If unspecified, it will hang up. + */ + voicemailMessage?: string | undefined; + /** + * This is the message that the assistant will say if it ends the call. + * + * If unspecified, it will hang up without saying anything. + */ + endCallMessage?: string | undefined; + /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ + endCallPhrases?: string[] | undefined; + compliancePlan?: Vapi.CompliancePlan | undefined; + /** This is for metadata you want to store on the assistant. */ + metadata?: Record | undefined; + /** + * This enables filtering of noise and background speech while the user is talking. + * + * Features: + * - Smart denoising using Krisp + * - Fourier denoising + * + * Smart denoising can be combined with or used independently of Fourier denoising. + * + * Order of precedence: + * - Smart denoising + * - Fourier denoising + */ + backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan | undefined; + /** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */ + analysisPlan?: Vapi.AnalysisPlan | undefined; + /** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */ + artifactPlan?: Vapi.ArtifactPlan | undefined; + /** + * This is the plan for when the assistant should start talking. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to start talking after the customer is done speaking. + * - The assistant is too fast to start talking after the customer is done speaking. + * - The assistant is so fast that it's actually interrupting the customer. + */ + startSpeakingPlan?: Vapi.StartSpeakingPlan | undefined; + /** + * This is the plan for when assistant should stop talking on customer interruption. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to recognize customer's interruption. + * - The assistant is too fast to recognize customer's interruption. + * - The assistant is getting interrupted by phrases that are just acknowledgments. + * - The assistant is getting interrupted by background noises. + * - The assistant is not properly stopping -- it starts talking right after getting interrupted. + */ + stopSpeakingPlan?: Vapi.StopSpeakingPlan | undefined; + /** + * This is the plan for real-time monitoring of the assistant's calls. + * + * Usage: + * - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. + * - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`. + * - To attach monitors to the assistant, set `monitorPlan.monitorIds` to the set of monitor ids. + */ + monitorPlan?: Vapi.MonitorPlan | undefined; + /** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */ + credentialIds?: string[] | undefined; + /** + * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. + * + * The order of precedence is: + * + * 1. assistant.server.url + * 2. phoneNumber.serverUrl + * 3. org.serverUrl + */ + server?: Vapi.Server | undefined; + keypadInputPlan?: Vapi.KeypadInputPlan | undefined; + /** + * Optional pointer to the published version this draft was forked from. + * When omitted on `POST /assistant/:id/draft`, defaults server-side to the + * parent assistant's current `latestVersion` (which is lazy-created via + * `assistantBaselineVersionEnsureInTx` if the parent has never been + * versioned). Immutable for the lifetime of the draft. + */ + baseVersion?: string | undefined; +} diff --git a/src/api/types/CreateAssistantDraftDtoBackgroundSound.ts b/src/api/types/CreateAssistantDraftDtoBackgroundSound.ts new file mode 100644 index 00000000..fc4f1cf6 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoBackgroundSound.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ +export type CreateAssistantDraftDtoBackgroundSound = Vapi.CreateAssistantDraftDtoBackgroundSoundZero | string; diff --git a/src/api/types/CreateAssistantDraftDtoBackgroundSoundZero.ts b/src/api/types/CreateAssistantDraftDtoBackgroundSoundZero.ts new file mode 100644 index 00000000..55a74e93 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoBackgroundSoundZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CreateAssistantDraftDtoBackgroundSoundZero = { + Off: "off", + Office: "office", +} as const; +export type CreateAssistantDraftDtoBackgroundSoundZero = + (typeof CreateAssistantDraftDtoBackgroundSoundZero)[keyof typeof CreateAssistantDraftDtoBackgroundSoundZero]; diff --git a/src/api/types/CreateAssistantDraftDtoClientMessagesItem.ts b/src/api/types/CreateAssistantDraftDtoClientMessagesItem.ts new file mode 100644 index 00000000..3e4fcbee --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoClientMessagesItem.ts @@ -0,0 +1,25 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CreateAssistantDraftDtoClientMessagesItem = { + ConversationUpdate: "conversation-update", + AssistantSpeechStarted: "assistant.speechStarted", + FunctionCall: "function-call", + FunctionCallResult: "function-call-result", + Hang: "hang", + LanguageChanged: "language-changed", + Metadata: "metadata", + ModelOutput: "model-output", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + ToolCalls: "tool-calls", + ToolCallsResult: "tool-calls-result", + ToolCompleted: "tool.completed", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + WorkflowNodeStarted: "workflow.node.started", + AssistantStarted: "assistant.started", +} as const; +export type CreateAssistantDraftDtoClientMessagesItem = + (typeof CreateAssistantDraftDtoClientMessagesItem)[keyof typeof CreateAssistantDraftDtoClientMessagesItem]; diff --git a/src/api/types/CreateAssistantDraftDtoCredentialsItem.ts b/src/api/types/CreateAssistantDraftDtoCredentialsItem.ts new file mode 100644 index 00000000..061a6839 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoCredentialsItem.ts @@ -0,0 +1,352 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type CreateAssistantDraftDtoCredentialsItem = + | Vapi.CreateAssistantDraftDtoCredentialsItem._11Labs + | Vapi.CreateAssistantDraftDtoCredentialsItem.Anthropic + | Vapi.CreateAssistantDraftDtoCredentialsItem.AnthropicBedrock + | Vapi.CreateAssistantDraftDtoCredentialsItem.Anyscale + | Vapi.CreateAssistantDraftDtoCredentialsItem.AssemblyAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.AzureOpenai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Azure + | Vapi.CreateAssistantDraftDtoCredentialsItem.ByoSipTrunk + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cartesia + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cerebras + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cloudflare + | Vapi.CreateAssistantDraftDtoCredentialsItem.CustomLlm + | Vapi.CreateAssistantDraftDtoCredentialsItem.Deepgram + | Vapi.CreateAssistantDraftDtoCredentialsItem.Deepinfra + | Vapi.CreateAssistantDraftDtoCredentialsItem.DeepSeek + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gcp + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gladia + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gohighlevel + | Vapi.CreateAssistantDraftDtoCredentialsItem.Google + | Vapi.CreateAssistantDraftDtoCredentialsItem.Groq + | Vapi.CreateAssistantDraftDtoCredentialsItem.InflectionAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Langfuse + | Vapi.CreateAssistantDraftDtoCredentialsItem.Lmnt + | Vapi.CreateAssistantDraftDtoCredentialsItem.Make + | Vapi.CreateAssistantDraftDtoCredentialsItem.Openai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Openrouter + | Vapi.CreateAssistantDraftDtoCredentialsItem.PerplexityAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Playht + | Vapi.CreateAssistantDraftDtoCredentialsItem.RimeAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Runpod + | Vapi.CreateAssistantDraftDtoCredentialsItem.S3 + | Vapi.CreateAssistantDraftDtoCredentialsItem.S3Compatible + | Vapi.CreateAssistantDraftDtoCredentialsItem.Supabase + | Vapi.CreateAssistantDraftDtoCredentialsItem.SmallestAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Tavus + | Vapi.CreateAssistantDraftDtoCredentialsItem.TogetherAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Twilio + | Vapi.CreateAssistantDraftDtoCredentialsItem.Vonage + | Vapi.CreateAssistantDraftDtoCredentialsItem.Webhook + | Vapi.CreateAssistantDraftDtoCredentialsItem.CustomCredential + | Vapi.CreateAssistantDraftDtoCredentialsItem.Xai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Microsoft + | Vapi.CreateAssistantDraftDtoCredentialsItem.Neuphonic + | Vapi.CreateAssistantDraftDtoCredentialsItem.Hume + | Vapi.CreateAssistantDraftDtoCredentialsItem.Mistral + | Vapi.CreateAssistantDraftDtoCredentialsItem.Speechmatics + | Vapi.CreateAssistantDraftDtoCredentialsItem.Soniox + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.SlackOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.GhlOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.Inworld + | Vapi.CreateAssistantDraftDtoCredentialsItem.Minimax + | Vapi.CreateAssistantDraftDtoCredentialsItem.Wellsaid + | Vapi.CreateAssistantDraftDtoCredentialsItem.Email + | Vapi.CreateAssistantDraftDtoCredentialsItem.SlackWebhook; + +export namespace CreateAssistantDraftDtoCredentialsItem { + export interface _11Labs extends Vapi.CreateElevenLabsCredentialDto { + provider: "11labs"; + } + + export interface Anthropic extends Vapi.CreateAnthropicCredentialDto { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.CreateAnthropicBedrockCredentialDto { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.CreateAnyscaleCredentialDto { + provider: "anyscale"; + } + + export interface AssemblyAi extends Vapi.CreateAssemblyAiCredentialDto { + provider: "assembly-ai"; + } + + export interface AzureOpenai extends Vapi.CreateAzureOpenAiCredentialDto { + provider: "azure-openai"; + } + + export interface Azure extends Vapi.CreateAzureCredentialDto { + provider: "azure"; + } + + export interface ByoSipTrunk extends Vapi.CreateByoSipTrunkCredentialDto { + provider: "byo-sip-trunk"; + } + + export interface Cartesia extends Vapi.CreateCartesiaCredentialDto { + provider: "cartesia"; + } + + export interface Cerebras extends Vapi.CreateCerebrasCredentialDto { + provider: "cerebras"; + } + + export interface Cloudflare extends Vapi.CreateCloudflareCredentialDto { + provider: "cloudflare"; + } + + export interface CustomLlm extends Vapi.CreateCustomLlmCredentialDto { + provider: "custom-llm"; + } + + export interface Deepgram extends Vapi.CreateDeepgramCredentialDto { + provider: "deepgram"; + } + + export interface Deepinfra extends Vapi.CreateDeepInfraCredentialDto { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.CreateDeepSeekCredentialDto { + provider: "deep-seek"; + } + + export interface Gcp extends Vapi.CreateGcpCredentialDto { + provider: "gcp"; + } + + export interface Gladia extends Vapi.CreateGladiaCredentialDto { + provider: "gladia"; + } + + export interface Gohighlevel extends Vapi.CreateGoHighLevelCredentialDto { + provider: "gohighlevel"; + } + + export interface Google extends Vapi.CreateGoogleCredentialDto { + provider: "google"; + } + + export interface Groq extends Vapi.CreateGroqCredentialDto { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.CreateInflectionAiCredentialDto { + provider: "inflection-ai"; + } + + export interface Langfuse extends Vapi.CreateLangfuseCredentialDto { + provider: "langfuse"; + } + + export interface Lmnt extends Vapi.CreateLmntCredentialDto { + provider: "lmnt"; + } + + export interface Make extends Vapi.CreateMakeCredentialDto { + provider: "make"; + } + + export interface Openai extends Vapi.CreateOpenAiCredentialDto { + provider: "openai"; + } + + export interface Openrouter extends Vapi.CreateOpenRouterCredentialDto { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.CreatePerplexityAiCredentialDto { + provider: "perplexity-ai"; + } + + export interface Playht extends Vapi.CreatePlayHtCredentialDto { + provider: "playht"; + } + + export interface RimeAi extends Vapi.CreateRimeAiCredentialDto { + provider: "rime-ai"; + } + + export interface Runpod extends Vapi.CreateRunpodCredentialDto { + provider: "runpod"; + } + + export interface S3 extends Vapi.CreateS3CredentialDto { + provider: "s3"; + } + + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { + provider: "supabase"; + } + + export interface SmallestAi extends Vapi.CreateSmallestAiCredentialDto { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.CreateTavusCredentialDto { + provider: "tavus"; + } + + export interface TogetherAi extends Vapi.CreateTogetherAiCredentialDto { + provider: "together-ai"; + } + + export interface Twilio extends Vapi.CreateTwilioCredentialDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonageCredentialDto { + provider: "vonage"; + } + + export interface Webhook extends Vapi.CreateWebhookCredentialDto { + provider: "webhook"; + } + + export interface CustomCredential extends Vapi.CreateCustomCredentialDto { + provider: "custom-credential"; + } + + export interface Xai extends Vapi.CreateXAiCredentialDto { + provider: "xai"; + } + + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { + provider: "neuphonic"; + } + + export interface Hume extends Vapi.CreateHumeCredentialDto { + provider: "hume"; + } + + export interface Mistral extends Vapi.CreateMistralCredentialDto { + provider: "mistral"; + } + + export interface Speechmatics extends Vapi.CreateSpeechmaticsCredentialDto { + provider: "speechmatics"; + } + + export interface Soniox extends Vapi.CreateSonioxCredentialDto { + provider: "soniox"; + } + + export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { + provider: "google.calendar.oauth2-client"; + } + + export interface GoogleCalendarOauth2Authorization + extends Vapi.CreateGoogleCalendarOAuth2AuthorizationCredentialDto { + provider: "google.calendar.oauth2-authorization"; + } + + export interface GoogleSheetsOauth2Authorization extends Vapi.CreateGoogleSheetsOAuth2AuthorizationCredentialDto { + provider: "google.sheets.oauth2-authorization"; + } + + export interface SlackOauth2Authorization extends Vapi.CreateSlackOAuth2AuthorizationCredentialDto { + provider: "slack.oauth2-authorization"; + } + + export interface GhlOauth2Authorization extends Vapi.CreateGoHighLevelMcpCredentialDto { + provider: "ghl.oauth2-authorization"; + } + + export interface Inworld extends Vapi.CreateInworldCredentialDto { + provider: "inworld"; + } + + export interface Minimax extends Vapi.CreateMinimaxCredentialDto { + provider: "minimax"; + } + + export interface Wellsaid extends Vapi.CreateWellSaidCredentialDto { + provider: "wellsaid"; + } + + export interface Email extends Vapi.CreateEmailCredentialDto { + provider: "email"; + } + + export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { + provider: "slack-webhook"; + } + + export type Response = + | Vapi.CreateAssistantDraftDtoCredentialsItem._11Labs + | Vapi.CreateAssistantDraftDtoCredentialsItem.Anthropic + | Vapi.CreateAssistantDraftDtoCredentialsItem.AnthropicBedrock + | Vapi.CreateAssistantDraftDtoCredentialsItem.Anyscale + | Vapi.CreateAssistantDraftDtoCredentialsItem.AssemblyAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.AzureOpenai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Azure + | Vapi.CreateAssistantDraftDtoCredentialsItem.ByoSipTrunk + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cartesia + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cerebras + | Vapi.CreateAssistantDraftDtoCredentialsItem.Cloudflare + | Vapi.CreateAssistantDraftDtoCredentialsItem.CustomLlm + | Vapi.CreateAssistantDraftDtoCredentialsItem.Deepgram + | Vapi.CreateAssistantDraftDtoCredentialsItem.Deepinfra + | Vapi.CreateAssistantDraftDtoCredentialsItem.DeepSeek + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gcp + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gladia + | Vapi.CreateAssistantDraftDtoCredentialsItem.Gohighlevel + | Vapi.CreateAssistantDraftDtoCredentialsItem.Google + | Vapi.CreateAssistantDraftDtoCredentialsItem.Groq + | Vapi.CreateAssistantDraftDtoCredentialsItem.InflectionAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Langfuse + | Vapi.CreateAssistantDraftDtoCredentialsItem.Lmnt + | Vapi.CreateAssistantDraftDtoCredentialsItem.Make + | Vapi.CreateAssistantDraftDtoCredentialsItem.Openai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Openrouter + | Vapi.CreateAssistantDraftDtoCredentialsItem.PerplexityAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Playht + | Vapi.CreateAssistantDraftDtoCredentialsItem.RimeAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Runpod + | Vapi.CreateAssistantDraftDtoCredentialsItem.S3 + | Vapi.CreateAssistantDraftDtoCredentialsItem.S3Compatible + | Vapi.CreateAssistantDraftDtoCredentialsItem.Supabase + | Vapi.CreateAssistantDraftDtoCredentialsItem.SmallestAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Tavus + | Vapi.CreateAssistantDraftDtoCredentialsItem.TogetherAi + | Vapi.CreateAssistantDraftDtoCredentialsItem.Twilio + | Vapi.CreateAssistantDraftDtoCredentialsItem.Vonage + | Vapi.CreateAssistantDraftDtoCredentialsItem.Webhook + | Vapi.CreateAssistantDraftDtoCredentialsItem.CustomCredential + | Vapi.CreateAssistantDraftDtoCredentialsItem.Xai + | Vapi.CreateAssistantDraftDtoCredentialsItem.Microsoft + | Vapi.CreateAssistantDraftDtoCredentialsItem.Neuphonic + | Vapi.CreateAssistantDraftDtoCredentialsItem.Hume + | Vapi.CreateAssistantDraftDtoCredentialsItem.Mistral + | Vapi.CreateAssistantDraftDtoCredentialsItem.Speechmatics + | Vapi.CreateAssistantDraftDtoCredentialsItem.Soniox + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.SlackOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.GhlOauth2Authorization + | Vapi.CreateAssistantDraftDtoCredentialsItem.Inworld + | Vapi.CreateAssistantDraftDtoCredentialsItem.Minimax + | Vapi.CreateAssistantDraftDtoCredentialsItem.Wellsaid + | Vapi.CreateAssistantDraftDtoCredentialsItem.Email + | Vapi.CreateAssistantDraftDtoCredentialsItem.SlackWebhook; +} diff --git a/src/api/types/CreateAssistantDraftDtoFirstMessageMode.ts b/src/api/types/CreateAssistantDraftDtoFirstMessageMode.ts new file mode 100644 index 00000000..21722235 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoFirstMessageMode.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ +export const CreateAssistantDraftDtoFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantSpeaksFirstWithModelGeneratedMessage: "assistant-speaks-first-with-model-generated-message", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type CreateAssistantDraftDtoFirstMessageMode = + (typeof CreateAssistantDraftDtoFirstMessageMode)[keyof typeof CreateAssistantDraftDtoFirstMessageMode]; diff --git a/src/api/types/CreateAssistantDraftDtoHooksItem.ts b/src/api/types/CreateAssistantDraftDtoHooksItem.ts new file mode 100644 index 00000000..8824ab82 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoHooksItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type CreateAssistantDraftDtoHooksItem = + | Vapi.CallHookCallEnding + | Vapi.CallHookAssistantSpeechInterrupted + | Vapi.CallHookCustomerSpeechInterrupted + | Vapi.CallHookCustomerSpeechTimeout + | Vapi.SessionCreatedHook; diff --git a/src/api/types/CreateAssistantDraftDtoModel.ts b/src/api/types/CreateAssistantDraftDtoModel.ts new file mode 100644 index 00000000..631665e3 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoModel.ts @@ -0,0 +1,117 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's LLM. + */ +export type CreateAssistantDraftDtoModel = + | Vapi.CreateAssistantDraftDtoModel.Anthropic + | Vapi.CreateAssistantDraftDtoModel.AnthropicBedrock + | Vapi.CreateAssistantDraftDtoModel.Anyscale + | Vapi.CreateAssistantDraftDtoModel.Cerebras + | Vapi.CreateAssistantDraftDtoModel.CustomLlm + | Vapi.CreateAssistantDraftDtoModel.Deepinfra + | Vapi.CreateAssistantDraftDtoModel.DeepSeek + | Vapi.CreateAssistantDraftDtoModel.Google + | Vapi.CreateAssistantDraftDtoModel.Groq + | Vapi.CreateAssistantDraftDtoModel.InflectionAi + | Vapi.CreateAssistantDraftDtoModel.Minimax + | Vapi.CreateAssistantDraftDtoModel.Openai + | Vapi.CreateAssistantDraftDtoModel.Openrouter + | Vapi.CreateAssistantDraftDtoModel.PerplexityAi + | Vapi.CreateAssistantDraftDtoModel.TogetherAi + | Vapi.CreateAssistantDraftDtoModel.Xai + | Vapi.CreateAssistantDraftDtoModel.Vapi; + +export namespace CreateAssistantDraftDtoModel { + export interface Anthropic extends Vapi.AnthropicModel { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.AnthropicBedrockModel { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.AnyscaleModel { + provider: "anyscale"; + } + + export interface Cerebras extends Vapi.CerebrasModel { + provider: "cerebras"; + } + + export interface CustomLlm extends Vapi.CustomLlmModel { + provider: "custom-llm"; + } + + export interface Deepinfra extends Vapi.DeepInfraModel { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.DeepSeekModel { + provider: "deep-seek"; + } + + export interface Google extends Vapi.GoogleModel { + provider: "google"; + } + + export interface Groq extends Vapi.GroqModel { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.InflectionAiModel { + provider: "inflection-ai"; + } + + export interface Minimax extends Vapi.MinimaxLlmModel { + provider: "minimax"; + } + + export interface Openai extends Vapi.OpenAiModel { + provider: "openai"; + } + + export interface Openrouter extends Vapi.OpenRouterModel { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.PerplexityAiModel { + provider: "perplexity-ai"; + } + + export interface TogetherAi extends Vapi.TogetherAiModel { + provider: "together-ai"; + } + + export interface Xai extends Vapi.XaiModel { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.CreateAssistantDraftDtoModel.Anthropic + | Vapi.CreateAssistantDraftDtoModel.AnthropicBedrock + | Vapi.CreateAssistantDraftDtoModel.Anyscale + | Vapi.CreateAssistantDraftDtoModel.Cerebras + | Vapi.CreateAssistantDraftDtoModel.CustomLlm + | Vapi.CreateAssistantDraftDtoModel.Deepinfra + | Vapi.CreateAssistantDraftDtoModel.DeepSeek + | Vapi.CreateAssistantDraftDtoModel.Google + | Vapi.CreateAssistantDraftDtoModel.Groq + | Vapi.CreateAssistantDraftDtoModel.InflectionAi + | Vapi.CreateAssistantDraftDtoModel.Minimax + | Vapi.CreateAssistantDraftDtoModel.Openai + | Vapi.CreateAssistantDraftDtoModel.Openrouter + | Vapi.CreateAssistantDraftDtoModel.PerplexityAi + | Vapi.CreateAssistantDraftDtoModel.TogetherAi + | Vapi.CreateAssistantDraftDtoModel.Xai + | Vapi.CreateAssistantDraftDtoModel.Vapi; +} diff --git a/src/api/types/CreateAssistantDraftDtoServerMessagesItem.ts b/src/api/types/CreateAssistantDraftDtoServerMessagesItem.ts new file mode 100644 index 00000000..25f3a7d8 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoServerMessagesItem.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CreateAssistantDraftDtoServerMessagesItem = { + AssistantStarted: "assistant.started", + AssistantSpeechStarted: "assistant.speechStarted", + ConversationUpdate: "conversation-update", + EndOfCallReport: "end-of-call-report", + FunctionCall: "function-call", + Hang: "hang", + LanguageChanged: "language-changed", + LanguageChangeDetected: "language-change-detected", + ModelOutput: "model-output", + PhoneCallControl: "phone-call-control", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + TranscriptTranscriptTypeFinal: 'transcript[transcriptType="final"]', + ToolCalls: "tool-calls", + TransferDestinationRequest: "transfer-destination-request", + HandoffDestinationRequest: "handoff-destination-request", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + ChatCreated: "chat.created", + ChatDeleted: "chat.deleted", + SessionCreated: "session.created", + SessionUpdated: "session.updated", + SessionDeleted: "session.deleted", + CallDeleted: "call.deleted", + CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", +} as const; +export type CreateAssistantDraftDtoServerMessagesItem = + (typeof CreateAssistantDraftDtoServerMessagesItem)[keyof typeof CreateAssistantDraftDtoServerMessagesItem]; diff --git a/src/api/types/CreateAssistantDraftDtoTranscriber.ts b/src/api/types/CreateAssistantDraftDtoTranscriber.ts new file mode 100644 index 00000000..6b7807f7 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoTranscriber.ts @@ -0,0 +1,80 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's transcriber. + */ +export type CreateAssistantDraftDtoTranscriber = + | Vapi.CreateAssistantDraftDtoTranscriber.AssemblyAi + | Vapi.CreateAssistantDraftDtoTranscriber.Azure + | Vapi.CreateAssistantDraftDtoTranscriber.CustomTranscriber + | Vapi.CreateAssistantDraftDtoTranscriber.Deepgram + | Vapi.CreateAssistantDraftDtoTranscriber._11Labs + | Vapi.CreateAssistantDraftDtoTranscriber.Gladia + | Vapi.CreateAssistantDraftDtoTranscriber.Google + | Vapi.CreateAssistantDraftDtoTranscriber.Speechmatics + | Vapi.CreateAssistantDraftDtoTranscriber.Talkscriber + | Vapi.CreateAssistantDraftDtoTranscriber.Openai + | Vapi.CreateAssistantDraftDtoTranscriber.Cartesia + | Vapi.CreateAssistantDraftDtoTranscriber.Soniox + | Vapi.CreateAssistantDraftDtoTranscriber.Xai + | Vapi.CreateAssistantDraftDtoTranscriber.Vapi; + +export namespace CreateAssistantDraftDtoTranscriber { + export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { + provider: "assembly-ai"; + } + + export interface Azure extends Vapi.AzureSpeechTranscriber { + provider: "azure"; + } + + export interface CustomTranscriber extends Vapi.CustomTranscriber { + provider: "custom-transcriber"; + } + + export interface Deepgram extends Vapi.DeepgramTranscriber { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsTranscriber { + provider: "11labs"; + } + + export interface Gladia extends Vapi.GladiaTranscriber { + provider: "gladia"; + } + + export interface Google extends Vapi.GoogleTranscriber { + provider: "google"; + } + + export interface Speechmatics extends Vapi.SpeechmaticsTranscriber { + provider: "speechmatics"; + } + + export interface Talkscriber extends Vapi.TalkscriberTranscriber { + provider: "talkscriber"; + } + + export interface Openai extends Vapi.OpenAiTranscriber { + provider: "openai"; + } + + export interface Cartesia extends Vapi.CartesiaTranscriber { + provider: "cartesia"; + } + + export interface Soniox extends Vapi.SonioxTranscriber { + provider: "soniox"; + } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } +} diff --git a/src/api/types/CreateAssistantDraftDtoVoice.ts b/src/api/types/CreateAssistantDraftDtoVoice.ts new file mode 100644 index 00000000..ffcb0cc9 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoVoice.ts @@ -0,0 +1,110 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's voice. + */ +export type CreateAssistantDraftDtoVoice = + | Vapi.CreateAssistantDraftDtoVoice.Azure + | Vapi.CreateAssistantDraftDtoVoice.Cartesia + | Vapi.CreateAssistantDraftDtoVoice.CustomVoice + | Vapi.CreateAssistantDraftDtoVoice.Deepgram + | Vapi.CreateAssistantDraftDtoVoice._11Labs + | Vapi.CreateAssistantDraftDtoVoice.Hume + | Vapi.CreateAssistantDraftDtoVoice.Lmnt + | Vapi.CreateAssistantDraftDtoVoice.Neuphonic + | Vapi.CreateAssistantDraftDtoVoice.Openai + | Vapi.CreateAssistantDraftDtoVoice.Playht + | Vapi.CreateAssistantDraftDtoVoice.Wellsaid + | Vapi.CreateAssistantDraftDtoVoice.RimeAi + | Vapi.CreateAssistantDraftDtoVoice.SmallestAi + | Vapi.CreateAssistantDraftDtoVoice.Tavus + | Vapi.CreateAssistantDraftDtoVoice.Vapi + | Vapi.CreateAssistantDraftDtoVoice.Sesame + | Vapi.CreateAssistantDraftDtoVoice.Inworld + | Vapi.CreateAssistantDraftDtoVoice.Minimax + | Vapi.CreateAssistantDraftDtoVoice.Xai + | Vapi.CreateAssistantDraftDtoVoice.Microsoft; + +export namespace CreateAssistantDraftDtoVoice { + export interface Azure extends Vapi.AzureVoice { + provider: "azure"; + } + + export interface Cartesia extends Vapi.CartesiaVoice { + provider: "cartesia"; + } + + export interface CustomVoice extends Vapi.CustomVoice { + provider: "custom-voice"; + } + + export interface Deepgram extends Vapi.DeepgramVoice { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsVoice { + provider: "11labs"; + } + + export interface Hume extends Vapi.HumeVoice { + provider: "hume"; + } + + export interface Lmnt extends Vapi.LmntVoice { + provider: "lmnt"; + } + + export interface Neuphonic extends Vapi.NeuphonicVoice { + provider: "neuphonic"; + } + + export interface Openai extends Vapi.OpenAiVoice { + provider: "openai"; + } + + export interface Playht extends Vapi.PlayHtVoice { + provider: "playht"; + } + + export interface Wellsaid extends Vapi.WellSaidVoice { + provider: "wellsaid"; + } + + export interface RimeAi extends Vapi.RimeAiVoice { + provider: "rime-ai"; + } + + export interface SmallestAi extends Vapi.SmallestAiVoice { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.TavusVoice { + provider: "tavus"; + } + + export interface Vapi extends Vapi.VapiVoice { + provider: "vapi"; + } + + export interface Sesame extends Vapi.SesameVoice { + provider: "sesame"; + } + + export interface Inworld extends Vapi.InworldVoice { + provider: "inworld"; + } + + export interface Minimax extends Vapi.MinimaxVoice { + provider: "minimax"; + } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } +} diff --git a/src/api/types/CreateAssistantDraftDtoVoicemailDetection.ts b/src/api/types/CreateAssistantDraftDtoVoicemailDetection.ts new file mode 100644 index 00000000..512dec9e --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoVoicemailDetection.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ +export type CreateAssistantDraftDtoVoicemailDetection = + | Vapi.CreateAssistantDraftDtoVoicemailDetectionZero + | Vapi.GoogleVoicemailDetectionPlan + | Vapi.OpenAiVoicemailDetectionPlan + | Vapi.TwilioVoicemailDetectionPlan + | Vapi.VapiVoicemailDetectionPlan; diff --git a/src/api/types/CreateAssistantDraftDtoVoicemailDetectionZero.ts b/src/api/types/CreateAssistantDraftDtoVoicemailDetectionZero.ts new file mode 100644 index 00000000..a4425307 --- /dev/null +++ b/src/api/types/CreateAssistantDraftDtoVoicemailDetectionZero.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CreateAssistantDraftDtoVoicemailDetectionZero = { + Off: "off", +} as const; +export type CreateAssistantDraftDtoVoicemailDetectionZero = + (typeof CreateAssistantDraftDtoVoicemailDetectionZero)[keyof typeof CreateAssistantDraftDtoVoicemailDetectionZero]; diff --git a/src/api/types/CreateAssistantDto.ts b/src/api/types/CreateAssistantDto.ts index d9c9a164..5f0285a2 100644 --- a/src/api/types/CreateAssistantDto.ts +++ b/src/api/types/CreateAssistantDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and conversation behavior. + */ export interface CreateAssistantDto { /** These are the options for the assistant's transcriber. */ transcriber?: Vapi.CreateAssistantDtoTranscriber | undefined; @@ -15,6 +18,7 @@ export interface CreateAssistantDto { * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. */ firstMessage?: string | undefined; + /** Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ firstMessageInterruptionsEnabled?: boolean | undefined; /** * This is the mode for the first message. Default is 'assistant-speaks-first'. @@ -85,6 +89,7 @@ export interface CreateAssistantDto { endCallMessage?: string | undefined; /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ endCallPhrases?: string[] | undefined; + /** Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ compliancePlan?: Vapi.CompliancePlan | undefined; /** This is for metadata you want to store on the assistant. */ metadata?: Record | undefined; @@ -147,5 +152,6 @@ export interface CreateAssistantDto { * 3. org.serverUrl */ server?: Vapi.Server | undefined; + /** Configuration for collecting and processing DTMF keypad input during calls. */ keypadInputPlan?: Vapi.KeypadInputPlan | undefined; } diff --git a/src/api/types/CreateAssistantDtoCredentialsItem.ts b/src/api/types/CreateAssistantDtoCredentialsItem.ts index 78f039f4..b1cf2c14 100644 --- a/src/api/types/CreateAssistantDtoCredentialsItem.ts +++ b/src/api/types/CreateAssistantDtoCredentialsItem.ts @@ -34,6 +34,7 @@ export type CreateAssistantDtoCredentialsItem = | Vapi.CreateAssistantDtoCredentialsItem.RimeAi | Vapi.CreateAssistantDtoCredentialsItem.Runpod | Vapi.CreateAssistantDtoCredentialsItem.S3 + | Vapi.CreateAssistantDtoCredentialsItem.S3Compatible | Vapi.CreateAssistantDtoCredentialsItem.Supabase | Vapi.CreateAssistantDtoCredentialsItem.SmallestAi | Vapi.CreateAssistantDtoCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type CreateAssistantDtoCredentialsItem = | Vapi.CreateAssistantDtoCredentialsItem.Webhook | Vapi.CreateAssistantDtoCredentialsItem.CustomCredential | Vapi.CreateAssistantDtoCredentialsItem.Xai + | Vapi.CreateAssistantDtoCredentialsItem.Microsoft | Vapi.CreateAssistantDtoCredentialsItem.Neuphonic | Vapi.CreateAssistantDtoCredentialsItem.Hume | Vapi.CreateAssistantDtoCredentialsItem.Mistral | Vapi.CreateAssistantDtoCredentialsItem.Speechmatics | Vapi.CreateAssistantDtoCredentialsItem.Soniox - | Vapi.CreateAssistantDtoCredentialsItem.Trieve | Vapi.CreateAssistantDtoCredentialsItem.GoogleCalendarOauth2Client | Vapi.CreateAssistantDtoCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.CreateAssistantDtoCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace CreateAssistantDtoCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace CreateAssistantDtoCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace CreateAssistantDtoCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace CreateAssistantDtoCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.CreateAssistantDtoCredentialsItem._11Labs + | Vapi.CreateAssistantDtoCredentialsItem.Anthropic + | Vapi.CreateAssistantDtoCredentialsItem.AnthropicBedrock + | Vapi.CreateAssistantDtoCredentialsItem.Anyscale + | Vapi.CreateAssistantDtoCredentialsItem.AssemblyAi + | Vapi.CreateAssistantDtoCredentialsItem.AzureOpenai + | Vapi.CreateAssistantDtoCredentialsItem.Azure + | Vapi.CreateAssistantDtoCredentialsItem.ByoSipTrunk + | Vapi.CreateAssistantDtoCredentialsItem.Cartesia + | Vapi.CreateAssistantDtoCredentialsItem.Cerebras + | Vapi.CreateAssistantDtoCredentialsItem.Cloudflare + | Vapi.CreateAssistantDtoCredentialsItem.CustomLlm + | Vapi.CreateAssistantDtoCredentialsItem.Deepgram + | Vapi.CreateAssistantDtoCredentialsItem.Deepinfra + | Vapi.CreateAssistantDtoCredentialsItem.DeepSeek + | Vapi.CreateAssistantDtoCredentialsItem.Gcp + | Vapi.CreateAssistantDtoCredentialsItem.Gladia + | Vapi.CreateAssistantDtoCredentialsItem.Gohighlevel + | Vapi.CreateAssistantDtoCredentialsItem.Google + | Vapi.CreateAssistantDtoCredentialsItem.Groq + | Vapi.CreateAssistantDtoCredentialsItem.InflectionAi + | Vapi.CreateAssistantDtoCredentialsItem.Langfuse + | Vapi.CreateAssistantDtoCredentialsItem.Lmnt + | Vapi.CreateAssistantDtoCredentialsItem.Make + | Vapi.CreateAssistantDtoCredentialsItem.Openai + | Vapi.CreateAssistantDtoCredentialsItem.Openrouter + | Vapi.CreateAssistantDtoCredentialsItem.PerplexityAi + | Vapi.CreateAssistantDtoCredentialsItem.Playht + | Vapi.CreateAssistantDtoCredentialsItem.RimeAi + | Vapi.CreateAssistantDtoCredentialsItem.Runpod + | Vapi.CreateAssistantDtoCredentialsItem.S3 + | Vapi.CreateAssistantDtoCredentialsItem.S3Compatible + | Vapi.CreateAssistantDtoCredentialsItem.Supabase + | Vapi.CreateAssistantDtoCredentialsItem.SmallestAi + | Vapi.CreateAssistantDtoCredentialsItem.Tavus + | Vapi.CreateAssistantDtoCredentialsItem.TogetherAi + | Vapi.CreateAssistantDtoCredentialsItem.Twilio + | Vapi.CreateAssistantDtoCredentialsItem.Vonage + | Vapi.CreateAssistantDtoCredentialsItem.Webhook + | Vapi.CreateAssistantDtoCredentialsItem.CustomCredential + | Vapi.CreateAssistantDtoCredentialsItem.Xai + | Vapi.CreateAssistantDtoCredentialsItem.Microsoft + | Vapi.CreateAssistantDtoCredentialsItem.Neuphonic + | Vapi.CreateAssistantDtoCredentialsItem.Hume + | Vapi.CreateAssistantDtoCredentialsItem.Mistral + | Vapi.CreateAssistantDtoCredentialsItem.Speechmatics + | Vapi.CreateAssistantDtoCredentialsItem.Soniox + | Vapi.CreateAssistantDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.CreateAssistantDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.CreateAssistantDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.CreateAssistantDtoCredentialsItem.SlackOauth2Authorization + | Vapi.CreateAssistantDtoCredentialsItem.GhlOauth2Authorization + | Vapi.CreateAssistantDtoCredentialsItem.Inworld + | Vapi.CreateAssistantDtoCredentialsItem.Minimax + | Vapi.CreateAssistantDtoCredentialsItem.Wellsaid + | Vapi.CreateAssistantDtoCredentialsItem.Email + | Vapi.CreateAssistantDtoCredentialsItem.SlackWebhook; } diff --git a/src/api/types/CreateAssistantDtoModel.ts b/src/api/types/CreateAssistantDtoModel.ts index 4295c9c6..63ce4b83 100644 --- a/src/api/types/CreateAssistantDtoModel.ts +++ b/src/api/types/CreateAssistantDtoModel.ts @@ -21,7 +21,8 @@ export type CreateAssistantDtoModel = | Vapi.CreateAssistantDtoModel.Openrouter | Vapi.CreateAssistantDtoModel.PerplexityAi | Vapi.CreateAssistantDtoModel.TogetherAi - | Vapi.CreateAssistantDtoModel.Xai; + | Vapi.CreateAssistantDtoModel.Xai + | Vapi.CreateAssistantDtoModel.Vapi; export namespace CreateAssistantDtoModel { export interface Anthropic extends Vapi.AnthropicModel { @@ -87,4 +88,30 @@ export namespace CreateAssistantDtoModel { export interface Xai extends Vapi.XaiModel { provider: "xai"; } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.CreateAssistantDtoModel.Anthropic + | Vapi.CreateAssistantDtoModel.AnthropicBedrock + | Vapi.CreateAssistantDtoModel.Anyscale + | Vapi.CreateAssistantDtoModel.Cerebras + | Vapi.CreateAssistantDtoModel.CustomLlm + | Vapi.CreateAssistantDtoModel.Deepinfra + | Vapi.CreateAssistantDtoModel.DeepSeek + | Vapi.CreateAssistantDtoModel.Google + | Vapi.CreateAssistantDtoModel.Groq + | Vapi.CreateAssistantDtoModel.InflectionAi + | Vapi.CreateAssistantDtoModel.Minimax + | Vapi.CreateAssistantDtoModel.Openai + | Vapi.CreateAssistantDtoModel.Openrouter + | Vapi.CreateAssistantDtoModel.PerplexityAi + | Vapi.CreateAssistantDtoModel.TogetherAi + | Vapi.CreateAssistantDtoModel.Xai + | Vapi.CreateAssistantDtoModel.Vapi; } diff --git a/src/api/types/CreateAssistantDtoServerMessagesItem.ts b/src/api/types/CreateAssistantDtoServerMessagesItem.ts index 8b1696f6..2e4515c8 100644 --- a/src/api/types/CreateAssistantDtoServerMessagesItem.ts +++ b/src/api/types/CreateAssistantDtoServerMessagesItem.ts @@ -28,6 +28,7 @@ export const CreateAssistantDtoServerMessagesItem = { SessionDeleted: "session.deleted", CallDeleted: "call.deleted", CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", } as const; export type CreateAssistantDtoServerMessagesItem = (typeof CreateAssistantDtoServerMessagesItem)[keyof typeof CreateAssistantDtoServerMessagesItem]; diff --git a/src/api/types/CreateAssistantDtoTranscriber.ts b/src/api/types/CreateAssistantDtoTranscriber.ts index 00ab534e..d23f08fb 100644 --- a/src/api/types/CreateAssistantDtoTranscriber.ts +++ b/src/api/types/CreateAssistantDtoTranscriber.ts @@ -17,7 +17,9 @@ export type CreateAssistantDtoTranscriber = | Vapi.CreateAssistantDtoTranscriber.Talkscriber | Vapi.CreateAssistantDtoTranscriber.Openai | Vapi.CreateAssistantDtoTranscriber.Cartesia - | Vapi.CreateAssistantDtoTranscriber.Soniox; + | Vapi.CreateAssistantDtoTranscriber.Soniox + | Vapi.CreateAssistantDtoTranscriber.Xai + | Vapi.CreateAssistantDtoTranscriber.Vapi; export namespace CreateAssistantDtoTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -67,4 +69,12 @@ export namespace CreateAssistantDtoTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/CreateAssistantDtoVoice.ts b/src/api/types/CreateAssistantDtoVoice.ts index f6736b5a..48c2505f 100644 --- a/src/api/types/CreateAssistantDtoVoice.ts +++ b/src/api/types/CreateAssistantDtoVoice.ts @@ -23,7 +23,9 @@ export type CreateAssistantDtoVoice = | Vapi.CreateAssistantDtoVoice.Vapi | Vapi.CreateAssistantDtoVoice.Sesame | Vapi.CreateAssistantDtoVoice.Inworld - | Vapi.CreateAssistantDtoVoice.Minimax; + | Vapi.CreateAssistantDtoVoice.Minimax + | Vapi.CreateAssistantDtoVoice.Xai + | Vapi.CreateAssistantDtoVoice.Microsoft; export namespace CreateAssistantDtoVoice { export interface Azure extends Vapi.AzureVoice { @@ -97,4 +99,12 @@ export namespace CreateAssistantDtoVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/CreateAzureCredentialDto.ts b/src/api/types/CreateAzureCredentialDto.ts index b13e23f6..0fe9943d 100644 --- a/src/api/types/CreateAzureCredentialDto.ts +++ b/src/api/types/CreateAzureCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings. + */ export interface CreateAzureCredentialDto { /** This is the service being used in Azure. */ service: Vapi.CreateAzureCredentialDtoService; diff --git a/src/api/types/CreateAzureCredentialDtoRegion.ts b/src/api/types/CreateAzureCredentialDtoRegion.ts index da6eda0b..aa77361f 100644 --- a/src/api/types/CreateAzureCredentialDtoRegion.ts +++ b/src/api/types/CreateAzureCredentialDtoRegion.ts @@ -20,6 +20,8 @@ export const CreateAzureCredentialDtoRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/CreateAzureOpenAiCredentialDto.ts b/src/api/types/CreateAzureOpenAiCredentialDto.ts index 212bb821..b5b7f14f 100644 --- a/src/api/types/CreateAzureOpenAiCredentialDto.ts +++ b/src/api/types/CreateAzureOpenAiCredentialDto.ts @@ -2,13 +2,19 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and available models. + */ export interface CreateAzureOpenAiCredentialDto { + /** Azure region that hosts the OpenAI resource. */ region: Vapi.CreateAzureOpenAiCredentialDtoRegion; + /** Azure OpenAI models available through this credential. */ models: Vapi.CreateAzureOpenAiCredentialDtoModelsItem[]; /** This is not returned in the API. */ openAIKey: string; /** This is not returned in the API. */ ocpApimSubscriptionKey?: string | undefined; + /** Endpoint URL for the Azure OpenAI resource. */ openAIEndpoint: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateAzureOpenAiCredentialDtoModelsItem.ts b/src/api/types/CreateAzureOpenAiCredentialDtoModelsItem.ts index 76931b07..da62a1d2 100644 --- a/src/api/types/CreateAzureOpenAiCredentialDtoModelsItem.ts +++ b/src/api/types/CreateAzureOpenAiCredentialDtoModelsItem.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. export const CreateAzureOpenAiCredentialDtoModelsItem = { + Gpt56Luna20260709: "gpt-5.6-luna-2026-07-09", + Gpt56Terra20260709: "gpt-5.6-terra-2026-07-09", + Gpt56Sol20260709: "gpt-5.6-sol-2026-07-09", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -24,6 +27,9 @@ export const CreateAzureOpenAiCredentialDtoModelsItem = { Gpt40613: "gpt-4-0613", Gpt35Turbo0125: "gpt-35-turbo-0125", Gpt35Turbo1106: "gpt-35-turbo-1106", + Gpt4O: "gpt-4o", + Gpt41: "gpt-4.1", + Gpt54Mini20260317: "gpt-5.4-mini-2026-03-17", } as const; export type CreateAzureOpenAiCredentialDtoModelsItem = (typeof CreateAzureOpenAiCredentialDtoModelsItem)[keyof typeof CreateAzureOpenAiCredentialDtoModelsItem]; diff --git a/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts b/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts index 9f81bf63..1ee51e1a 100644 --- a/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts +++ b/src/api/types/CreateAzureOpenAiCredentialDtoRegion.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Azure region that hosts the OpenAI resource. */ export const CreateAzureOpenAiCredentialDtoRegion = { Australiaeast: "australiaeast", Canadaeast: "canadaeast", @@ -19,6 +20,8 @@ export const CreateAzureOpenAiCredentialDtoRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/CreateBarInsightFromCallTableDto.ts b/src/api/types/CreateBarInsightFromCallTableDto.ts index bafb40a5..c18d0d7b 100644 --- a/src/api/types/CreateBarInsightFromCallTableDto.ts +++ b/src/api/types/CreateBarInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ export interface CreateBarInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface CreateBarInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreateBashToolDto.ts b/src/api/types/CreateBashToolDto.ts index 5eeedf9b..c5d9dea9 100644 --- a/src/api/types/CreateBashToolDto.ts +++ b/src/api/types/CreateBashToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that executes shell commands in a configured environment. + */ export interface CreateBashToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateBashToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.CreateBashToolDtoSubType; diff --git a/src/api/types/CreateByoPhoneNumberDto.ts b/src/api/types/CreateByoPhoneNumberDto.ts index a5574e69..268ec064 100644 --- a/src/api/types/CreateByoPhoneNumberDto.ts +++ b/src/api/types/CreateByoPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing settings. + */ export interface CreateByoPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateByoSipTrunkCredentialDto.ts b/src/api/types/CreateByoSipTrunkCredentialDto.ts index 4dba7308..87a3d541 100644 --- a/src/api/types/CreateByoSipTrunkCredentialDto.ts +++ b/src/api/types/CreateByoSipTrunkCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for connecting Vapi to a bring-your-own SIP trunk or carrier, including gateways, outbound authentication, number handling, and optional session border controller routing. + */ export interface CreateByoSipTrunkCredentialDto { /** This is the list of SIP trunk's gateways. */ gateways: Vapi.SipTrunkGateway[]; @@ -20,8 +23,6 @@ export interface CreateByoSipTrunkCredentialDto { techPrefix?: string | undefined; /** This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property. */ sipDiversionHeader?: string | undefined; - /** This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi. */ - sbcConfiguration?: Vapi.SbcConfiguration | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/CreateCampaignDto.ts b/src/api/types/CreateCampaignDto.ts new file mode 100644 index 00000000..4be52f9b --- /dev/null +++ b/src/api/types/CreateCampaignDto.ts @@ -0,0 +1,39 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * Configuration used to create an outbound calling campaign. Choose an assistant, squad, or workflow, then provide customers, phone-number or dial-plan settings, and an optional schedule. + */ +export interface CreateCampaignDto { + /** This is the name of the campaign. This is just for your own reference. */ + name: string; + /** This is the assistant ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ + assistantId?: string | undefined; + /** This is the workflow ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ + workflowId?: string | undefined; + /** This is the squad ID that will be used for the campaign calls. Note: Only one of assistantId, workflowId, or squadId can be used. */ + squadId?: string | undefined; + /** This is the phone number ID that will be used for the campaign calls. Required if dialPlan is not provided. Note: phoneNumberId and dialPlan are mutually exclusive. */ + phoneNumberId?: string | undefined; + /** This is a list of dial entries, each specifying a phone number and the customers to call using that number. Use this when you want different phone numbers to call different sets of customers. Note: phoneNumberId and dialPlan are mutually exclusive. */ + dialPlan?: Vapi.DialPlanEntry[] | undefined; + /** This is the schedule plan for the campaign. Calls will start at startedAt and continue until your organization’s concurrency limit is reached. Any remaining calls will be retried for up to one hour as capacity becomes available. After that hour or after latestAt, whichever comes first, any calls that couldn’t be placed won’t be retried. */ + schedulePlan?: Vapi.SchedulePlan | undefined; + /** These are the customers that will be called in the campaign. Required if dialPlan is not provided. Maximum of 10000 customers per campaign. */ + customers?: Vapi.CreateCustomerDto[] | undefined; + /** This is the maximum number of concurrent calls that will be made for the campaign. Defaults to 10. */ + maxConcurrency?: number | undefined; + /** These are the overrides for the assistant's settings and template variables for the campaign. Use this when the campaign targets an `assistantId`. */ + assistantOverrides?: Vapi.AssistantOverrides | undefined; + /** These are the overrides for the squad and template variables for the campaign. Use this when the campaign targets a `squadId`. Per-contact `squadOverrides` are deep-merged on top of this at dispatch time. */ + squadOverrides?: Vapi.AssistantOverrides | undefined; + /** This is the server (URL, auth headers, timeout, etc.) for the campaign webhooks. */ + server?: Vapi.Server | undefined; + /** These are the messages that will be sent to your Server URL. */ + serverMessages?: Vapi.CreateCampaignDtoServerMessagesItem[] | undefined; + /** This opts the campaign into the blocking `campaign.predial` eligibility webhook. When set, every contact triggers a `campaign.predial` POST to the Server URL before dialing, and the response `{ eligible: boolean }` decides whether the call is placed. Requires `server`. When unset, no pre-dial webhook is sent. */ + predialPlan?: Vapi.CampaignPredialPlan | undefined; + /** Optional campaign ID to duplicate config from. Provided fields in the request override the source. If `customers` is omitted, contacts are copied from the source. */ + duplicateFromCampaignId?: string | undefined; +} diff --git a/src/api/types/CreateCampaignDtoServerMessagesItem.ts b/src/api/types/CreateCampaignDtoServerMessagesItem.ts new file mode 100644 index 00000000..191e69aa --- /dev/null +++ b/src/api/types/CreateCampaignDtoServerMessagesItem.ts @@ -0,0 +1,17 @@ +// This file was auto-generated by Fern from our API Definition. + +export const CreateCampaignDtoServerMessagesItem = { + CampaignStarted: "campaign.started", + CampaignCancelled: "campaign.cancelled", + CampaignEnded: "campaign.ended", + CampaignArchived: "campaign.archived", + CampaignUnarchived: "campaign.unarchived", + ContactDispatched: "contact.dispatched", + ContactCompleted: "contact.completed", + ContactFailed: "contact.failed", + ContactSkipped: "contact.skipped", + ContactPredialFailed: "contact.predial-failed", + CampaignJobContinued: "campaign.job.continued", +} as const; +export type CreateCampaignDtoServerMessagesItem = + (typeof CreateCampaignDtoServerMessagesItem)[keyof typeof CreateCampaignDtoServerMessagesItem]; diff --git a/src/api/types/CreateCartesiaCredentialDto.ts b/src/api/types/CreateCartesiaCredentialDto.ts index dedf1fd5..206c8329 100644 --- a/src/api/types/CreateCartesiaCredentialDto.ts +++ b/src/api/types/CreateCartesiaCredentialDto.ts @@ -1,8 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Cartesia. + */ export interface CreateCartesiaCredentialDto { /** This is not returned in the API. */ apiKey: string; + /** This can be used to point to an onprem Cartesia instance. Defaults to api.cartesia.ai. */ + apiUrl?: string | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/CreateCerebrasCredentialDto.ts b/src/api/types/CreateCerebrasCredentialDto.ts index c9f400ab..4fa66a5f 100644 --- a/src/api/types/CreateCerebrasCredentialDto.ts +++ b/src/api/types/CreateCerebrasCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Cerebras. + */ export interface CreateCerebrasCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateCloudflareCredentialDto.ts b/src/api/types/CreateCloudflareCredentialDto.ts index fb7e0497..f7e958a9 100644 --- a/src/api/types/CreateCloudflareCredentialDto.ts +++ b/src/api/types/CreateCloudflareCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and upload fallback order. + */ export interface CreateCloudflareCredentialDto { /** Cloudflare Account Id. */ accountId?: string | undefined; diff --git a/src/api/types/CreateCodeToolDto.ts b/src/api/types/CreateCodeToolDto.ts index dee3d932..e8dcf14d 100644 --- a/src/api/types/CreateCodeToolDto.ts +++ b/src/api/types/CreateCodeToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ export interface CreateCodeToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateCodeToolDtoMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/CreateComputerToolDto.ts b/src/api/types/CreateComputerToolDto.ts index 1ea1bd82..b69207c8 100644 --- a/src/api/types/CreateComputerToolDto.ts +++ b/src/api/types/CreateComputerToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ export interface CreateComputerToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateComputerToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.CreateComputerToolDtoSubType; diff --git a/src/api/types/CreateCustomCredentialDto.ts b/src/api/types/CreateCustomCredentialDto.ts index d3706986..07bd36cc 100644 --- a/src/api/types/CreateCustomCredentialDto.ts +++ b/src/api/types/CreateCustomCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for sensitive request data. + */ export interface CreateCustomCredentialDto { /** This is the authentication plan. Supports OAuth2 RFC 6749, HMAC signing, and Bearer authentication. */ authenticationPlan: Vapi.CreateCustomCredentialDtoAuthenticationPlan; diff --git a/src/api/types/CreateCustomKnowledgeBaseDto.ts b/src/api/types/CreateCustomKnowledgeBaseDto.ts index e15a604c..25205440 100644 --- a/src/api/types/CreateCustomKnowledgeBaseDto.ts +++ b/src/api/types/CreateCustomKnowledgeBaseDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for connecting a custom knowledge-base implementation through a customer-hosted server. + */ export interface CreateCustomKnowledgeBaseDto { /** This knowledge base is bring your own knowledge base implementation. */ provider: Vapi.CreateCustomKnowledgeBaseDtoProvider; diff --git a/src/api/types/CreateCustomLlmCredentialDto.ts b/src/api/types/CreateCustomLlmCredentialDto.ts index 311fb9c6..25372219 100644 --- a/src/api/types/CreateCustomLlmCredentialDto.ts +++ b/src/api/types/CreateCustomLlmCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication plan. + */ export interface CreateCustomLlmCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateCustomerDto.ts b/src/api/types/CreateCustomerDto.ts index 35052af2..0c48578d 100644 --- a/src/api/types/CreateCustomerDto.ts +++ b/src/api/types/CreateCustomerDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact identifiers, extension, and assistant overrides. + */ export interface CreateCustomerDto { /** * 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. @@ -22,6 +25,12 @@ export interface CreateCustomerDto { * This allows customization of the assistant's behavior for individual customers in batch calls. */ assistantOverrides?: Vapi.AssistantOverrides | undefined; + /** + * These are the overrides applied when the call targets a `squadId`. Mirrors + * the call-level `squadOverrides` — use this instead of `assistantOverrides` + * when the campaign or call is squad-based. + */ + squadOverrides?: Vapi.AssistantOverrides | undefined; /** This is the number of the customer. */ number?: string | undefined; /** This is the SIP URI of the customer. */ diff --git a/src/api/types/CreateDeepInfraCredentialDto.ts b/src/api/types/CreateDeepInfraCredentialDto.ts index fd64ca77..d23cf93f 100644 --- a/src/api/types/CreateDeepInfraCredentialDto.ts +++ b/src/api/types/CreateDeepInfraCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with DeepInfra. + */ export interface CreateDeepInfraCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDeepSeekCredentialDto.ts b/src/api/types/CreateDeepSeekCredentialDto.ts index e6c093b3..558a98ea 100644 --- a/src/api/types/CreateDeepSeekCredentialDto.ts +++ b/src/api/types/CreateDeepSeekCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with DeepSeek. + */ export interface CreateDeepSeekCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDeepgramCredentialDto.ts b/src/api/types/CreateDeepgramCredentialDto.ts index 75732212..a66374f7 100644 --- a/src/api/types/CreateDeepgramCredentialDto.ts +++ b/src/api/types/CreateDeepgramCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API URL for an on-premises instance. + */ export interface CreateDeepgramCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateDtmfToolDto.ts b/src/api/types/CreateDtmfToolDto.ts index edce636c..1f486711 100644 --- a/src/api/types/CreateDtmfToolDto.ts +++ b/src/api/types/CreateDtmfToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call. + */ export interface CreateDtmfToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateDtmfToolDtoMessagesItem[] | undefined; /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833 (RTP events). When enabled, DTMF digits will be sent using the SIP INFO method, which can be more reliable in some network configurations. Only relevant when using the `vapi.sip` transport. */ sipInfoDtmfEnabled?: boolean | undefined; diff --git a/src/api/types/CreateElevenLabsCredentialDto.ts b/src/api/types/CreateElevenLabsCredentialDto.ts index 43996126..bf2490b7 100644 --- a/src/api/types/CreateElevenLabsCredentialDto.ts +++ b/src/api/types/CreateElevenLabsCredentialDto.ts @@ -1,8 +1,15 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs. + */ export interface CreateElevenLabsCredentialDto { /** This is not returned in the API. */ apiKey: string; + /** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ + apiUrl?: (Vapi.CreateElevenLabsCredentialDtoApiUrl | null) | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/CreateElevenLabsCredentialDtoApiUrl.ts b/src/api/types/CreateElevenLabsCredentialDtoApiUrl.ts new file mode 100644 index 00000000..ad6b3877 --- /dev/null +++ b/src/api/types/CreateElevenLabsCredentialDtoApiUrl.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ +export const CreateElevenLabsCredentialDtoApiUrl = { + HttpsApiElevenlabsIo: "https://api.elevenlabs.io", + HttpsApiEuResidencyElevenlabsIo: "https://api.eu.residency.elevenlabs.io", +} as const; +export type CreateElevenLabsCredentialDtoApiUrl = + (typeof CreateElevenLabsCredentialDtoApiUrl)[keyof typeof CreateElevenLabsCredentialDtoApiUrl]; diff --git a/src/api/types/CreateEmailCredentialDto.ts b/src/api/types/CreateEmailCredentialDto.ts index 8c5218c7..e51ec2ae 100644 --- a/src/api/types/CreateEmailCredentialDto.ts +++ b/src/api/types/CreateEmailCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Destination configuration for sending Vapi alerts to an email address. + */ export interface CreateEmailCredentialDto { /** The recipient email address for alerts */ email: string; diff --git a/src/api/types/CreateEndCallToolDto.ts b/src/api/types/CreateEndCallToolDto.ts index 9fafa84f..2cad4970 100644 --- a/src/api/types/CreateEndCallToolDto.ts +++ b/src/api/types/CreateEndCallToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant end the active call. + */ export interface CreateEndCallToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateEndCallToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateEvalDto.ts b/src/api/types/CreateEvalDto.ts index 97ecdccc..edd15bd9 100644 --- a/src/api/types/CreateEvalDto.ts +++ b/src/api/types/CreateEvalDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing assistant responses and tool calls. + */ export interface CreateEvalDto { /** * This is the mock conversation that will be used to evaluate the flow of the conversation. diff --git a/src/api/types/CreateFunctionToolDto.ts b/src/api/types/CreateFunctionToolDto.ts index 52a6940d..d00b7681 100644 --- a/src/api/types/CreateFunctionToolDto.ts +++ b/src/api/types/CreateFunctionToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a custom function tool that sends model-generated arguments to a server and returns the result to the assistant. + */ export interface CreateFunctionToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateFunctionToolDtoMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/CreateGcpCredentialDto.ts b/src/api/types/CreateGcpCredentialDto.ts index 3a985a2a..f9a226ef 100644 --- a/src/api/types/CreateGcpCredentialDto.ts +++ b/src/api/types/CreateGcpCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, bucket configuration, and upload fallback order. + */ export interface CreateGcpCredentialDto { /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ fallbackIndex?: number | undefined; @@ -13,6 +16,7 @@ export interface CreateGcpCredentialDto { gcpKey: Vapi.GcpKey; /** This is the region of the GCP resource. */ region?: string | undefined; + /** Bucket configuration used to store call artifacts in Google Cloud Storage. */ bucketPlan?: Vapi.BucketPlan | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateGhlToolDto.ts b/src/api/types/CreateGhlToolDto.ts index aee5e6e8..107030b2 100644 --- a/src/api/types/CreateGhlToolDto.ts +++ b/src/api/types/CreateGhlToolDto.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface CreateGhlToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGhlToolDtoMessagesItem[] | undefined; /** The type of tool. "ghl" for GHL tool. */ type: Vapi.CreateGhlToolDtoType; diff --git a/src/api/types/CreateGladiaCredentialDto.ts b/src/api/types/CreateGladiaCredentialDto.ts index fe700ced..10e61358 100644 --- a/src/api/types/CreateGladiaCredentialDto.ts +++ b/src/api/types/CreateGladiaCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Gladia. + */ export interface CreateGladiaCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts b/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts index 94e2e933..97d9e6a7 100644 --- a/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts +++ b/src/api/types/CreateGoHighLevelCalendarAvailabilityToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account. + */ export interface CreateGoHighLevelCalendarAvailabilityToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoHighLevelCalendarAvailabilityToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts b/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts index 8979aadd..bc7f5548 100644 --- a/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts +++ b/src/api/types/CreateGoHighLevelCalendarEventCreateToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds calendar events to a connected GoHighLevel account. + */ export interface CreateGoHighLevelCalendarEventCreateToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoHighLevelCalendarEventCreateToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoHighLevelContactCreateToolDto.ts b/src/api/types/CreateGoHighLevelContactCreateToolDto.ts index 1772bd6b..f9748781 100644 --- a/src/api/types/CreateGoHighLevelContactCreateToolDto.ts +++ b/src/api/types/CreateGoHighLevelContactCreateToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds contacts to a connected GoHighLevel account. + */ export interface CreateGoHighLevelContactCreateToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoHighLevelContactCreateToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoHighLevelContactGetToolDto.ts b/src/api/types/CreateGoHighLevelContactGetToolDto.ts index 46168341..b124f36f 100644 --- a/src/api/types/CreateGoHighLevelContactGetToolDto.ts +++ b/src/api/types/CreateGoHighLevelContactGetToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account. + */ export interface CreateGoHighLevelContactGetToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoHighLevelContactGetToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoHighLevelCredentialDto.ts b/src/api/types/CreateGoHighLevelCredentialDto.ts index a3050f8d..e0198641 100644 --- a/src/api/types/CreateGoHighLevelCredentialDto.ts +++ b/src/api/types/CreateGoHighLevelCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating Vapi integrations with GoHighLevel. + */ export interface CreateGoHighLevelCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoHighLevelMcpCredentialDto.ts b/src/api/types/CreateGoHighLevelMcpCredentialDto.ts index b4ab62c8..bcd5e055 100644 --- a/src/api/types/CreateGoHighLevelMcpCredentialDto.ts +++ b/src/api/types/CreateGoHighLevelMcpCredentialDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests. + */ export interface CreateGoHighLevelMcpCredentialDto { /** This is the authentication session for the credential. */ authenticationSession: Vapi.Oauth2AuthenticationSession; diff --git a/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts b/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts index 5129f2b8..3cfd8b37 100644 --- a/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts +++ b/src/api/types/CreateGoogleCalendarCheckAvailabilityToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that checks availability in a connected Google Calendar. + */ export interface CreateGoogleCalendarCheckAvailabilityToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoogleCalendarCheckAvailabilityToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts b/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts index 406a9073..f2675b11 100644 --- a/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts +++ b/src/api/types/CreateGoogleCalendarCreateEventToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that adds events to a connected Google Calendar. + */ export interface CreateGoogleCalendarCreateEventToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoogleCalendarCreateEventToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts index e2c5b21c..af21dd43 100644 --- a/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Google Calendar operations. + */ export interface CreateGoogleCalendarOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts b/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts index 7d275e65..555ba8af 100644 --- a/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts +++ b/src/api/types/CreateGoogleCalendarOAuth2ClientCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OAuth 2.0 client credential for Google Calendar integrations. + */ export interface CreateGoogleCalendarOAuth2ClientCredentialDto { /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateGoogleCredentialDto.ts b/src/api/types/CreateGoogleCredentialDto.ts index 5bf8c267..4df88d1a 100644 --- a/src/api/types/CreateGoogleCredentialDto.ts +++ b/src/api/types/CreateGoogleCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Google AI. + */ export interface CreateGoogleCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts index 0db16a6c..6e7f4187 100644 --- a/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Google Sheets operations. + */ export interface CreateGoogleSheetsOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts b/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts index 729ef215..ad67e48c 100644 --- a/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts +++ b/src/api/types/CreateGoogleSheetsRowAppendToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that appends rows to a connected Google Sheet. + */ export interface CreateGoogleSheetsRowAppendToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateGoogleSheetsRowAppendToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateGroqCredentialDto.ts b/src/api/types/CreateGroqCredentialDto.ts index bb99cbae..9652d407 100644 --- a/src/api/types/CreateGroqCredentialDto.ts +++ b/src/api/types/CreateGroqCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Groq. + */ export interface CreateGroqCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateHandoffToolDto.ts b/src/api/types/CreateHandoffToolDto.ts index 2ca788df..9a0e6371 100644 --- a/src/api/types/CreateHandoffToolDto.ts +++ b/src/api/types/CreateHandoffToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ export interface CreateHandoffToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateHandoffToolDtoMessagesItem[] | undefined; /** This is the default local tool result message used when no runtime handoff result override is returned. */ defaultResult?: string | undefined; diff --git a/src/api/types/CreateHandoffToolDtoDestinationsItem.ts b/src/api/types/CreateHandoffToolDtoDestinationsItem.ts index 5d6c61a6..3ab7c75f 100644 --- a/src/api/types/CreateHandoffToolDtoDestinationsItem.ts +++ b/src/api/types/CreateHandoffToolDtoDestinationsItem.ts @@ -19,4 +19,9 @@ export namespace CreateHandoffToolDtoDestinationsItem { export interface Squad extends Vapi.HandoffDestinationSquad { type: "squad"; } + + export type Response = + | Vapi.CreateHandoffToolDtoDestinationsItem.Assistant + | Vapi.CreateHandoffToolDtoDestinationsItem.Dynamic + | Vapi.CreateHandoffToolDtoDestinationsItem.Squad; } diff --git a/src/api/types/CreateHumeCredentialDto.ts b/src/api/types/CreateHumeCredentialDto.ts index f2894b24..c6c9afce 100644 --- a/src/api/types/CreateHumeCredentialDto.ts +++ b/src/api/types/CreateHumeCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Hume. + */ export interface CreateHumeCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateInflectionAiCredentialDto.ts b/src/api/types/CreateInflectionAiCredentialDto.ts index 18e0ebe2..1ddbc3a9 100644 --- a/src/api/types/CreateInflectionAiCredentialDto.ts +++ b/src/api/types/CreateInflectionAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Inflection AI. + */ export interface CreateInflectionAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateInworldCredentialDto.ts b/src/api/types/CreateInworldCredentialDto.ts index 941b8e35..69bb5e43 100644 --- a/src/api/types/CreateInworldCredentialDto.ts +++ b/src/api/types/CreateInworldCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Inworld. + */ export interface CreateInworldCredentialDto { /** This is the Inworld Basic (Base64) authentication token. This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateLangfuseCredentialDto.ts b/src/api/types/CreateLangfuseCredentialDto.ts index 57ff7adc..70fe35f4 100644 --- a/src/api/types/CreateLangfuseCredentialDto.ts +++ b/src/api/types/CreateLangfuseCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and host URL. + */ export interface CreateLangfuseCredentialDto { /** The public key for Langfuse project. Eg: pk-lf-... */ publicKey: string; diff --git a/src/api/types/CreateLineInsightFromCallTableDto.ts b/src/api/types/CreateLineInsightFromCallTableDto.ts index e62f9b5c..a87bc9ab 100644 --- a/src/api/types/CreateLineInsightFromCallTableDto.ts +++ b/src/api/types/CreateLineInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ export interface CreateLineInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface CreateLineInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreateLmntCredentialDto.ts b/src/api/types/CreateLmntCredentialDto.ts index 508156fb..344bf31f 100644 --- a/src/api/types/CreateLmntCredentialDto.ts +++ b/src/api/types/CreateLmntCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with LMNT. + */ export interface CreateLmntCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateMakeCredentialDto.ts b/src/api/types/CreateMakeCredentialDto.ts index b6f1a642..412d3106 100644 --- a/src/api/types/CreateMakeCredentialDto.ts +++ b/src/api/types/CreateMakeCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating Vapi integrations with Make, including team, region, and API key. + */ export interface CreateMakeCredentialDto { /** Team ID */ teamId: string; diff --git a/src/api/types/CreateMakeToolDto.ts b/src/api/types/CreateMakeToolDto.ts index f5fce03b..ca04f818 100644 --- a/src/api/types/CreateMakeToolDto.ts +++ b/src/api/types/CreateMakeToolDto.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface CreateMakeToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateMakeToolDtoMessagesItem[] | undefined; /** The type of tool. "make" for Make tool. */ type: Vapi.CreateMakeToolDtoType; diff --git a/src/api/types/CreateMcpToolDto.ts b/src/api/types/CreateMcpToolDto.ts index 1b73a2e6..1f3699a5 100644 --- a/src/api/types/CreateMcpToolDto.ts +++ b/src/api/types/CreateMcpToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ export interface CreateMcpToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateMcpToolDtoMessagesItem[] | undefined; /** * This is the server where a `tool-calls` webhook will be sent. @@ -22,6 +21,7 @@ export interface CreateMcpToolDto { server?: Vapi.Server | undefined; /** Per-tool message overrides for individual tools loaded from the MCP server. Set messages to an empty array to suppress messages for a specific tool. Tools not listed here will use the default messages from the parent tool. */ toolMessages?: Vapi.McpToolMessages[] | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateMicrosoftCredentialDto.ts b/src/api/types/CreateMicrosoftCredentialDto.ts new file mode 100644 index 00000000..6b5d57cb --- /dev/null +++ b/src/api/types/CreateMicrosoftCredentialDto.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface CreateMicrosoftCredentialDto { + /** This is not returned in the API. */ + apiKey: string; + /** Azure region for the Speech resource. Defaults to `eastus` when omitted. MAI-Voice-2 is preview and region-limited. */ + region?: string | undefined; + /** This is the name of credential. This is just for your reference. */ + name?: string | undefined; +} diff --git a/src/api/types/CreateMinimaxCredentialDto.ts b/src/api/types/CreateMinimaxCredentialDto.ts index 0a157271..456e6631 100644 --- a/src/api/types/CreateMinimaxCredentialDto.ts +++ b/src/api/types/CreateMinimaxCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax group identifier. + */ export interface CreateMinimaxCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateMistralCredentialDto.ts b/src/api/types/CreateMistralCredentialDto.ts index 604584cc..0a790217 100644 --- a/src/api/types/CreateMistralCredentialDto.ts +++ b/src/api/types/CreateMistralCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Mistral. + */ export interface CreateMistralCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateNeuphonicCredentialDto.ts b/src/api/types/CreateNeuphonicCredentialDto.ts index 5d379eb7..18c19304 100644 --- a/src/api/types/CreateNeuphonicCredentialDto.ts +++ b/src/api/types/CreateNeuphonicCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Neuphonic. + */ export interface CreateNeuphonicCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateOpenAiCredentialDto.ts b/src/api/types/CreateOpenAiCredentialDto.ts index 26638593..0912a522 100644 --- a/src/api/types/CreateOpenAiCredentialDto.ts +++ b/src/api/types/CreateOpenAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI. + */ export interface CreateOpenAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateOpenRouterCredentialDto.ts b/src/api/types/CreateOpenRouterCredentialDto.ts index cab67cbd..ccbe813a 100644 --- a/src/api/types/CreateOpenRouterCredentialDto.ts +++ b/src/api/types/CreateOpenRouterCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with OpenRouter. + */ export interface CreateOpenRouterCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateOutboundCallDto.ts b/src/api/types/CreateOutboundCallDto.ts index 42f0e7a5..8610342d 100644 --- a/src/api/types/CreateOutboundCallDto.ts +++ b/src/api/types/CreateOutboundCallDto.ts @@ -3,6 +3,13 @@ import type * as Vapi from "../index.js"; export interface CreateOutboundCallDto { + /** + * This is the assistant version to use for this call. Supported only with + * direct `assistantId`. Omit to follow the latest version. + */ + assistantVersion?: (string | null) | undefined; + /** This is the transport of the call. */ + transport?: Vapi.CreateOutboundCallDtoTransport | undefined; /** * This is used to issue batch calls to multiple customers. * @@ -13,8 +20,6 @@ export interface CreateOutboundCallDto { name?: string | undefined; /** This is the schedule plan of the call. */ schedulePlan?: Vapi.SchedulePlan | undefined; - /** This is the transport of the call. */ - transport?: Record | undefined; /** * This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. * diff --git a/src/api/types/CreateOutboundCallDtoTransport.ts b/src/api/types/CreateOutboundCallDtoTransport.ts new file mode 100644 index 00000000..85d2e946 --- /dev/null +++ b/src/api/types/CreateOutboundCallDtoTransport.ts @@ -0,0 +1,40 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the transport of the call. + */ +export type CreateOutboundCallDtoTransport = + | Vapi.CreateOutboundCallDtoTransport.VapiWebsocket + | Vapi.CreateOutboundCallDtoTransport.Vonage + | Vapi.CreateOutboundCallDtoTransport.Twilio + | Vapi.CreateOutboundCallDtoTransport.VapiSip + | Vapi.CreateOutboundCallDtoTransport.Telnyx + | Vapi.CreateOutboundCallDtoTransport.Daily; + +export namespace CreateOutboundCallDtoTransport { + export interface VapiWebsocket extends Vapi.VapiWebsocketTransport { + provider: "vapi.websocket"; + } + + export interface Vonage extends Vapi.VonageTransport { + provider: "vonage"; + } + + export interface Twilio extends Vapi.TwilioTransport { + provider: "twilio"; + } + + export interface VapiSip extends Vapi.VapiSipTransport { + provider: "vapi.sip"; + } + + export interface Telnyx extends Vapi.TelnyxTransport { + provider: "telnyx"; + } + + export interface Daily extends Vapi.VapiWebCallTransport { + provider: "daily"; + } +} diff --git a/src/api/types/CreateOutputToolDto.ts b/src/api/types/CreateOutputToolDto.ts index 456fba78..837295b5 100644 --- a/src/api/types/CreateOutputToolDto.ts +++ b/src/api/types/CreateOutputToolDto.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface CreateOutputToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateOutputToolDtoMessagesItem[] | undefined; /** The type of tool. "output" for Output tool. */ type: Vapi.CreateOutputToolDtoType; diff --git a/src/api/types/CreatePerplexityAiCredentialDto.ts b/src/api/types/CreatePerplexityAiCredentialDto.ts index 06eb35da..ccac2624 100644 --- a/src/api/types/CreatePerplexityAiCredentialDto.ts +++ b/src/api/types/CreatePerplexityAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Perplexity AI. + */ export interface CreatePerplexityAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreatePersonalityDto.ts b/src/api/types/CreatePersonalityDto.ts index be4eac76..b7629cd7 100644 --- a/src/api/types/CreatePersonalityDto.ts +++ b/src/api/types/CreatePersonalityDto.ts @@ -3,12 +3,9 @@ import type * as Vapi from "../index.js"; export interface CreatePersonalityDto { - /** This is the name of the personality (e.g., "Confused Carl", "Rude Rob"). */ + /** The display name of the personality, for example `Impatient customer`. */ name: string; - /** - * This is the full assistant configuration for this personality. - * It defines the tester's voice, model, behavior via system prompt, and other settings. - */ + /** The assistant configuration for the AI tester: the model, voice, and system prompt that determine how the AI tester behaves during the conversation. */ assistant: Vapi.CreateAssistantDto; /** * Optional folder path for organizing personalities. diff --git a/src/api/types/CreatePieInsightFromCallTableDto.ts b/src/api/types/CreatePieInsightFromCallTableDto.ts index 7255a861..2298b13d 100644 --- a/src/api/types/CreatePieInsightFromCallTableDto.ts +++ b/src/api/types/CreatePieInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range. + */ export interface CreatePieInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface CreatePieInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/CreatePlayHtCredentialDto.ts b/src/api/types/CreatePlayHtCredentialDto.ts index ab081ed7..16b90bf9 100644 --- a/src/api/types/CreatePlayHtCredentialDto.ts +++ b/src/api/types/CreatePlayHtCredentialDto.ts @@ -1,8 +1,12 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier. + */ export interface CreatePlayHtCredentialDto { /** This is not returned in the API. */ apiKey: string; + /** PlayHT user identifier associated with the API key. */ userId: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateQueryToolDto.ts b/src/api/types/CreateQueryToolDto.ts index ef9f31d3..15c63f69 100644 --- a/src/api/types/CreateQueryToolDto.ts +++ b/src/api/types/CreateQueryToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the assistant. + */ export interface CreateQueryToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateQueryToolDtoMessagesItem[] | undefined; /** The knowledge bases to query */ knowledgeBases?: Vapi.KnowledgeBase[] | undefined; diff --git a/src/api/types/CreateRimeAiCredentialDto.ts b/src/api/types/CreateRimeAiCredentialDto.ts index 87ea6a9a..0f42e2bd 100644 --- a/src/api/types/CreateRimeAiCredentialDto.ts +++ b/src/api/types/CreateRimeAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Rime AI. + */ export interface CreateRimeAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateRunpodCredentialDto.ts b/src/api/types/CreateRunpodCredentialDto.ts index ec9cb195..4431d77e 100644 --- a/src/api/types/CreateRunpodCredentialDto.ts +++ b/src/api/types/CreateRunpodCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests through Runpod. + */ export interface CreateRunpodCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateS3CompatibleCredentialDto.ts b/src/api/types/CreateS3CompatibleCredentialDto.ts new file mode 100644 index 00000000..1dcac515 --- /dev/null +++ b/src/api/types/CreateS3CompatibleCredentialDto.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CreateS3CompatibleCredentialDto { + bucketPlan: Vapi.S3CompatibleBucketPlan; + /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ + fallbackIndex?: number | undefined; + /** This is the name of credential. This is just for your reference. */ + name?: string | undefined; +} diff --git a/src/api/types/CreateS3CredentialDto.ts b/src/api/types/CreateS3CredentialDto.ts index 5abc471d..96afb752 100644 --- a/src/api/types/CreateS3CredentialDto.ts +++ b/src/api/types/CreateS3CredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and upload fallback order. + */ export interface CreateS3CredentialDto { /** AWS access key ID. */ awsAccessKeyId: string; diff --git a/src/api/types/CreateScenarioDto.ts b/src/api/types/CreateScenarioDto.ts index 22d6dd8e..1ebd7a4e 100644 --- a/src/api/types/CreateScenarioDto.ts +++ b/src/api/types/CreateScenarioDto.ts @@ -3,20 +3,17 @@ import type * as Vapi from "../index.js"; export interface CreateScenarioDto { - /** This is the name of the scenario. */ + /** The display name of the scenario, for example `Book an appointment`. */ name: string; - /** This is the script/instructions for the tester to follow during the simulation. */ + /** What the AI tester should try to accomplish in the conversation. Write it as the AI tester's goal, for example `Book an appointment for next week and confirm the time.` */ instructions: string; - /** - * This is the structured output-based evaluation plan for the simulation. - * Each item defines a structured output to extract and evaluate against an expected value. - */ + /** The checks that decide whether a run passes. Each evaluation compares a structured output against an expected value. At least one evaluation is required to run. */ evaluations: Vapi.EvaluationPlanItem[]; /** Hooks to run on simulation lifecycle events */ hooks?: Vapi.CreateScenarioDtoHooksItem[] | undefined; /** Overrides to inject into the simulated target assistant or squad */ targetOverrides?: Vapi.AssistantOverrides | undefined; - /** Scenario-level tool call mocks to use during simulations. */ + /** Mock results for the assistant or squad's tools during the simulation, so the run stays deterministic without calling real services. */ toolMocks?: Vapi.ScenarioToolMock[] | undefined; /** * Optional folder path for organizing scenarios. diff --git a/src/api/types/CreateScorecardDto.ts b/src/api/types/CreateScorecardDto.ts index 9327befe..ad576340 100644 --- a/src/api/types/CreateScorecardDto.ts +++ b/src/api/types/CreateScorecardDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant associations. + */ export interface CreateScorecardDto { /** This is the name of the scorecard. It is only for user reference and will not be used for any evaluation. */ name?: string | undefined; diff --git a/src/api/types/CreateSesameVoiceDto.ts b/src/api/types/CreateSesameVoiceDto.ts index 243ed45e..592f7451 100644 --- a/src/api/types/CreateSesameVoiceDto.ts +++ b/src/api/types/CreateSesameVoiceDto.ts @@ -1,8 +1,15 @@ // This file was auto-generated by Fern from our API Definition. export interface CreateSesameVoiceDto { + /** + * This is the audio file of the utterance to clone the voice from. + * Consumed by multer via FileInterceptor('file'), so it never reaches + * class-validator; declared here (like CreateFileDTO.file) so the OpenAPI + * spec is truthful about the multipart request body. + */ + file: string; /** The name of the voice. */ - voiceName?: string | undefined; + voiceName: string; /** The transcript of the utterance. */ - transcription?: string | undefined; + transcription: string; } diff --git a/src/api/types/CreateSimulationRunResponse.ts b/src/api/types/CreateSimulationRunResponse.ts new file mode 100644 index 00000000..fa7d6211 --- /dev/null +++ b/src/api/types/CreateSimulationRunResponse.ts @@ -0,0 +1,40 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CreateSimulationRunResponse { + /** Unique identifier for the run */ + id: string; + /** Organization ID */ + orgId: string; + /** Current status of the run */ + status: Vapi.CreateSimulationRunResponseStatus; + /** When the run was queued */ + queuedAt: string; + /** When the run started */ + startedAt?: string | undefined; + /** When the run ended */ + endedAt?: string | undefined; + /** Reason the run ended */ + endedReason?: string | undefined; + /** ISO 8601 date-time when created */ + createdAt: string; + /** ISO 8601 date-time when last updated */ + updatedAt: string; + /** Aggregate counts of run items by status */ + itemCounts?: Vapi.SimulationRunItemCounts | undefined; + /** Array of simulations and/or suites to run */ + simulations: Vapi.CreateSimulationRunResponseSimulationsItem[]; + /** Target to test against */ + target: Vapi.CreateSimulationRunResponseTarget; + /** Number of times to run each simulation (default: 1) */ + iterations?: number | undefined; + /** Transport configuration for the simulation runs */ + transport?: Vapi.SimulationRunTransportConfiguration | undefined; + /** IDs of the individual simulation run items that were queued */ + simulationRunItemIds: string[]; + /** Additional information about how the run will execute */ + message?: string | undefined; + /** Dashboard URL for viewing the simulation run. When acting on behalf of a user, present this URL to them. */ + url: string; +} diff --git a/src/api/types/CreateSimulationRunResponseSimulationsItem.ts b/src/api/types/CreateSimulationRunResponseSimulationsItem.ts new file mode 100644 index 00000000..b5c4ebf2 --- /dev/null +++ b/src/api/types/CreateSimulationRunResponseSimulationsItem.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type CreateSimulationRunResponseSimulationsItem = + | Vapi.CreateSimulationRunResponseSimulationsItem.Simulation + | Vapi.CreateSimulationRunResponseSimulationsItem.SimulationSuite; + +export namespace CreateSimulationRunResponseSimulationsItem { + export interface Simulation extends Vapi.SimulationRunSimulationEntry { + type: "simulation"; + } + + export interface SimulationSuite extends Vapi.SimulationRunSuiteEntry { + type: "simulationSuite"; + } + + export type Request = + | Vapi.CreateSimulationRunResponseSimulationsItem.Simulation + | Vapi.CreateSimulationRunResponseSimulationsItem.SimulationSuite; + export type Response = + | Vapi.CreateSimulationRunResponseSimulationsItem.Simulation + | Vapi.CreateSimulationRunResponseSimulationsItem.SimulationSuite; +} diff --git a/src/api/types/CreateSimulationRunResponseStatus.ts b/src/api/types/CreateSimulationRunResponseStatus.ts new file mode 100644 index 00000000..609dedfe --- /dev/null +++ b/src/api/types/CreateSimulationRunResponseStatus.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Current status of the run */ +export const CreateSimulationRunResponseStatus = { + Queued: "queued", + Running: "running", + Ended: "ended", +} as const; +export type CreateSimulationRunResponseStatus = + (typeof CreateSimulationRunResponseStatus)[keyof typeof CreateSimulationRunResponseStatus]; diff --git a/src/api/types/CreateSimulationRunResponseTarget.ts b/src/api/types/CreateSimulationRunResponseTarget.ts new file mode 100644 index 00000000..c6edbb17 --- /dev/null +++ b/src/api/types/CreateSimulationRunResponseTarget.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * Target to test against + */ +export type CreateSimulationRunResponseTarget = + | Vapi.CreateSimulationRunResponseTarget.Assistant + | Vapi.CreateSimulationRunResponseTarget.Squad; + +export namespace CreateSimulationRunResponseTarget { + export interface Assistant extends Vapi.SimulationRunTargetAssistant { + type: "assistant"; + } + + export interface Squad extends Vapi.SimulationRunTargetSquad { + type: "squad"; + } + + /** + * Target to test against + */ + export type Response = + | Vapi.CreateSimulationRunResponseTarget.Assistant + | Vapi.CreateSimulationRunResponseTarget.Squad; +} diff --git a/src/api/types/CreateSimulationSuiteDto.ts b/src/api/types/CreateSimulationSuiteDto.ts deleted file mode 100644 index 02b484b3..00000000 --- a/src/api/types/CreateSimulationSuiteDto.ts +++ /dev/null @@ -1,16 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export interface CreateSimulationSuiteDto { - /** This is the name of the simulation suite. */ - name: string; - /** This is the Slack webhook URL for notifications. */ - slackWebhookUrl?: string | undefined; - /** This is the list of simulation IDs to include in the suite. */ - simulationIds: string[]; - /** - * Optional folder path for organizing simulation suites. - * Supports up to 3 levels (e.g., "dept/feature/variant"). - * Maps to GitOps resource folder structure. - */ - path?: (string | null) | undefined; -} diff --git a/src/api/types/CreateSipRequestToolDto.ts b/src/api/types/CreateSipRequestToolDto.ts index 36f3c4b3..15a5193a 100644 --- a/src/api/types/CreateSipRequestToolDto.ts +++ b/src/api/types/CreateSipRequestToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ export interface CreateSipRequestToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateSipRequestToolDtoMessagesItem[] | undefined; /** The SIP method to send. */ verb: Vapi.CreateSipRequestToolDtoVerb; diff --git a/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts b/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts index 653f9634..da1eecd4 100644 --- a/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/CreateSlackOAuth2AuthorizationCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Stored OAuth 2.0 authorization for Slack operations. + */ export interface CreateSlackOAuth2AuthorizationCredentialDto { /** The authorization ID for the OAuth2 authorization */ authorizationId: string; diff --git a/src/api/types/CreateSlackSendMessageToolDto.ts b/src/api/types/CreateSlackSendMessageToolDto.ts index 213ac064..c8474948 100644 --- a/src/api/types/CreateSlackSendMessageToolDto.ts +++ b/src/api/types/CreateSlackSendMessageToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send a message to Slack. + */ export interface CreateSlackSendMessageToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateSlackSendMessageToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateSlackWebhookCredentialDto.ts b/src/api/types/CreateSlackWebhookCredentialDto.ts index 776e00e9..2a689516 100644 --- a/src/api/types/CreateSlackWebhookCredentialDto.ts +++ b/src/api/types/CreateSlackWebhookCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for sending Vapi alerts through a Slack incoming webhook. + */ export interface CreateSlackWebhookCredentialDto { /** Slack incoming webhook URL. See https://api.slack.com/messaging/webhooks for setup instructions. This is not returned in the API. */ webhookUrl: string; diff --git a/src/api/types/CreateSmallestAiCredentialDto.ts b/src/api/types/CreateSmallestAiCredentialDto.ts index f855651f..d8ce7b91 100644 --- a/src/api/types/CreateSmallestAiCredentialDto.ts +++ b/src/api/types/CreateSmallestAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Smallest AI. + */ export interface CreateSmallestAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateSmsToolDto.ts b/src/api/types/CreateSmsToolDto.ts index 4c480d95..eb22b12c 100644 --- a/src/api/types/CreateSmsToolDto.ts +++ b/src/api/types/CreateSmsToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that lets an assistant send an SMS message during a call. + */ export interface CreateSmsToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateSmsToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/CreateSonioxCredentialDto.ts b/src/api/types/CreateSonioxCredentialDto.ts index cfdc5df6..364e88e4 100644 --- a/src/api/types/CreateSonioxCredentialDto.ts +++ b/src/api/types/CreateSonioxCredentialDto.ts @@ -1,8 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Soniox. + */ export interface CreateSonioxCredentialDto { /** This is not returned in the API. */ apiKey: string; + /** Custom Soniox WebSocket endpoint (e.g. EU server wss://stt-rt.eu.soniox.com/transcribe-websocket). Defaults to the region-appropriate endpoint when omitted. */ + apiUrl?: string | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/CreateSpeechmaticsCredentialDto.ts b/src/api/types/CreateSpeechmaticsCredentialDto.ts index 272c3030..5a908464 100644 --- a/src/api/types/CreateSpeechmaticsCredentialDto.ts +++ b/src/api/types/CreateSpeechmaticsCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating transcription requests with Speechmatics. + */ export interface CreateSpeechmaticsCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateSquadDto.ts b/src/api/types/CreateSquadDto.ts index c4d802aa..d849851d 100644 --- a/src/api/types/CreateSquadDto.ts +++ b/src/api/types/CreateSquadDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a squad. Provide an ordered list of assistant members and optional overrides that control how the squad handles a conversation and transfers between assistants. + */ export interface CreateSquadDto { /** This is the name of the squad. */ name?: string | undefined; diff --git a/src/api/types/CreateStructuredOutputDto.ts b/src/api/types/CreateStructuredOutputDto.ts index 208950d7..f08e2aa3 100644 --- a/src/api/types/CreateStructuredOutputDto.ts +++ b/src/api/types/CreateStructuredOutputDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a structured-output definition that extracts validated data from calls using an AI model or regular expression. + */ export interface CreateStructuredOutputDto { /** * This is the type of structured output. @@ -43,6 +46,8 @@ export interface CreateStructuredOutputDto { model?: Vapi.CreateStructuredOutputDtoModel | undefined; /** Compliance configuration for this output. Only enable overrides if no sensitive data will be stored. */ compliancePlan?: Vapi.ComplianceOverride | undefined; + /** These are the conditions that gate the execution of this structured output. Every condition must pass for the structured output to run (AND semantics). When omitted or empty, no user-defined conditions gate this output. Send null to clear a previously saved gate. */ + conditions?: (Vapi.CreateStructuredOutputDtoConditionsItem[] | null) | undefined; /** This is the name of the structured output. */ name: string; /** diff --git a/src/api/types/CreateStructuredOutputDtoConditionsItem.ts b/src/api/types/CreateStructuredOutputDtoConditionsItem.ts new file mode 100644 index 00000000..98fa583a --- /dev/null +++ b/src/api/types/CreateStructuredOutputDtoConditionsItem.ts @@ -0,0 +1,22 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type CreateStructuredOutputDtoConditionsItem = + | Vapi.CreateStructuredOutputDtoConditionsItem.MinMessages + | Vapi.CreateStructuredOutputDtoConditionsItem.MinCallDuration + | Vapi.CreateStructuredOutputDtoConditionsItem.EndedReason; + +export namespace CreateStructuredOutputDtoConditionsItem { + export interface MinMessages extends Vapi.MinMessagesCondition { + type: "minMessages"; + } + + export interface MinCallDuration extends Vapi.MinCallDurationCondition { + type: "minCallDuration"; + } + + export interface EndedReason extends Vapi.EndedReasonCondition { + type: "endedReason"; + } +} diff --git a/src/api/types/CreateSupabaseCredentialDto.ts b/src/api/types/CreateSupabaseCredentialDto.ts index 2681e657..7a8a53ca 100644 --- a/src/api/types/CreateSupabaseCredentialDto.ts +++ b/src/api/types/CreateSupabaseCredentialDto.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and upload fallback order. + */ export interface CreateSupabaseCredentialDto { /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ fallbackIndex?: number | undefined; + /** Supabase S3-compatible bucket configuration used to store call artifacts. */ bucketPlan?: Vapi.SupabaseBucketPlan | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateTavusCredentialDto.ts b/src/api/types/CreateTavusCredentialDto.ts index 37168ac4..239412ae 100644 --- a/src/api/types/CreateTavusCredentialDto.ts +++ b/src/api/types/CreateTavusCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with Tavus. + */ export interface CreateTavusCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateTelnyxPhoneNumberDto.ts b/src/api/types/CreateTelnyxPhoneNumberDto.ts index ec71d389..3e5c1de8 100644 --- a/src/api/types/CreateTelnyxPhoneNumberDto.ts +++ b/src/api/types/CreateTelnyxPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings. + */ export interface CreateTelnyxPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateTextEditorToolDto.ts b/src/api/types/CreateTextEditorToolDto.ts index 441bd0cc..68d1c03e 100644 --- a/src/api/types/CreateTextEditorToolDto.ts +++ b/src/api/types/CreateTextEditorToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that reads and edits text files in a configured environment. + */ export interface CreateTextEditorToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateTextEditorToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.CreateTextEditorToolDtoSubType; diff --git a/src/api/types/CreateTextInsightFromCallTableDto.ts b/src/api/types/CreateTextInsightFromCallTableDto.ts index 1bdd029c..f9dae153 100644 --- a/src/api/types/CreateTextInsightFromCallTableDto.ts +++ b/src/api/types/CreateTextInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range. + */ export interface CreateTextInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface CreateTextInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. diff --git a/src/api/types/CreateTogetherAiCredentialDto.ts b/src/api/types/CreateTogetherAiCredentialDto.ts index ec46e6fd..569be28c 100644 --- a/src/api/types/CreateTogetherAiCredentialDto.ts +++ b/src/api/types/CreateTogetherAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with Together AI. + */ export interface CreateTogetherAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateToolDraftDto.ts b/src/api/types/CreateToolDraftDto.ts new file mode 100644 index 00000000..d3235b4e --- /dev/null +++ b/src/api/types/CreateToolDraftDto.ts @@ -0,0 +1,163 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface CreateToolDraftDto { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.CreateToolDraftDtoMessagesItem[] | undefined; + /** This is the type of the tool. */ + type?: Vapi.CreateToolDraftDtoType | undefined; + /** + * Optional pointer to the published version this draft was forked from. + * When omitted, defaults server-side to the parent tool's current + * `latestVersion` (lazy-created via `toolBaselineVersionEnsureInTx` if the + * tool has never been versioned). Immutable for the lifetime of the draft. + */ + baseVersion?: string | undefined; + /** This is the function definition of the tool. */ + function?: Vapi.OpenAiFunction | undefined; + /** + * Provider-specific metadata. Polymorphic across tool variants with no shared + * discriminator, so it is validated as a plain object (mirrors how + * `ToolCallResult.metadata` is typed). + */ + metadata?: Record | undefined; + /** This is the unique identifier for the template this tool was created from. */ + templateId?: string | undefined; + server?: Vapi.Server | undefined; + async?: boolean | undefined; + /** These are the destinations that the call can be transferred to. */ + destinations?: Record[] | undefined; + /** This is the name of the tool. This will be passed to the model. */ + name?: string | undefined; + /** This is the sub type of the tool (e.g. for computer, bash and text-editor tools). */ + subType?: string | undefined; + /** The display width in pixels (computer tool). */ + displayWidthPx?: number | undefined; + /** The display height in pixels (computer tool). */ + displayHeightPx?: number | undefined; + /** Optional display number (computer tool). */ + displayNumber?: number | undefined; + /** The knowledge bases to query (query tool). */ + knowledgeBases?: Vapi.KnowledgeBase[] | undefined; + /** This is where the request will be sent (api-request tool). */ + url?: string | undefined; + /** This is the HTTP method for the request (api-request tool). */ + method?: Vapi.CreateToolDraftDtoMethod | undefined; + /** These are the headers to send with the request (api-request / sip-request tool). */ + headers?: Vapi.JsonSchema | undefined; + /** + * This is the body of the request. Either a JSON schema (api-request) or a + * literal string / schema (sip-request). + */ + body?: Record | undefined; + /** This is the backoff plan if the request fails. */ + backoffPlan?: Vapi.BackoffPlan | undefined; + /** This is the timeout in seconds for the request. */ + timeoutSeconds?: number | undefined; + /** This is the description of the tool. This will be passed to the model. */ + description?: string | undefined; + /** This is the plan to extract variables from the tool's response. */ + variableExtractionPlan?: Vapi.VariableExtractionPlan | undefined; + /** This is the credential ID that will be used for authorization. */ + credentialId?: string | undefined; + extendedDelayWhenPrecededByTextEnabled?: boolean | undefined; + beepDetectionEnabled?: boolean | undefined; + /** This is the TypeScript code that will be executed when the tool is called (code tool). */ + code?: string | undefined; + /** These are the environment variables available in the code via the `env` object (code tool). */ + environmentVariables?: Vapi.CodeToolEnvironmentVariable[] | undefined; + /** These are the static parameters to merge into the tool's request body. */ + parameters?: Vapi.ToolParameter[] | undefined; + /** This is the paths to encrypt in the request body. */ + encryptedPaths?: string[] | undefined; + /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833. */ + sipInfoDtmfEnabled?: boolean | undefined; + /** This is the SIP method to send (sip-request tool). */ + verb?: Vapi.CreateToolDraftDtoVerb | undefined; + /** This is the default local tool result message used when no runtime override is returned (handoff tool). */ + defaultResult?: string | undefined; + /** Per-tool message overrides for individual tools loaded from the MCP server (mcp tool). */ + toolMessages?: Vapi.McpToolMessages[] | undefined; + /** + * This is the plan to reject a tool call based on the conversation state. + * + * // Example 1: Reject endCall if user didn't say goodbye + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', + * target: { position: -1, role: 'user' }, + * negate: true // Reject if pattern does NOT match + * }] + * } + * ``` + * + * // Example 2: Reject transfer if user is actually asking a question + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '\\?', + * target: { position: -1, role: 'user' } + * }] + * } + * ``` + * + * // Example 3: Reject transfer if user didn't mention transfer recently + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 5 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' %} + * {% assign mentioned = false %} + * {% for msg in userMessages %} + * {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} + * {% assign mentioned = true %} + * {% break %} + * {% endif %} + * {% endfor %} + * {% if mentioned %} + * false + * {% else %} + * true + * {% endif %}` + * }] + * } + * ``` + * + * // Example 4: Reject endCall if the bot is looping and trying to exit + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 6 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} + * {% if userMessages.size < 3 %} + * false + * {% else %} + * {% assign msg1 = userMessages[0].content | downcase %} + * {% assign msg2 = userMessages[1].content | downcase %} + * {% assign msg3 = userMessages[2].content | downcase %} + * {% comment %} Check for repetitive messages {% endcomment %} + * {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} + * true + * {% comment %} Check for common loop phrases {% endcomment %} + * {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} + * true + * {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} + * true + * {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} + * true + * {% else %} + * false + * {% endif %} + * {% endif %}` + * }] + * } + * ``` + */ + rejectionPlan?: Vapi.ToolRejectionPlan | undefined; +} diff --git a/src/api/types/CreateToolDraftDtoMessagesItem.ts b/src/api/types/CreateToolDraftDtoMessagesItem.ts new file mode 100644 index 00000000..72c2944a --- /dev/null +++ b/src/api/types/CreateToolDraftDtoMessagesItem.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type CreateToolDraftDtoMessagesItem = + | Vapi.CreateToolDraftDtoMessagesItem.RequestStart + | Vapi.CreateToolDraftDtoMessagesItem.RequestComplete + | Vapi.CreateToolDraftDtoMessagesItem.RequestFailed + | Vapi.CreateToolDraftDtoMessagesItem.RequestResponseDelayed; + +export namespace CreateToolDraftDtoMessagesItem { + export interface RequestStart extends Vapi.ToolMessageStart { + type: "request-start"; + } + + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } + + export interface RequestResponseDelayed extends Vapi.ToolMessageDelayed { + type: "request-response-delayed"; + } +} diff --git a/src/api/types/CreateToolDraftDtoMethod.ts b/src/api/types/CreateToolDraftDtoMethod.ts new file mode 100644 index 00000000..870879bb --- /dev/null +++ b/src/api/types/CreateToolDraftDtoMethod.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the HTTP method for the request (api-request tool). */ +export const CreateToolDraftDtoMethod = { + Post: "POST", + Get: "GET", + Put: "PUT", + Patch: "PATCH", + Delete: "DELETE", +} as const; +export type CreateToolDraftDtoMethod = (typeof CreateToolDraftDtoMethod)[keyof typeof CreateToolDraftDtoMethod]; diff --git a/src/api/types/CreateToolDraftDtoType.ts b/src/api/types/CreateToolDraftDtoType.ts new file mode 100644 index 00000000..568ea2c3 --- /dev/null +++ b/src/api/types/CreateToolDraftDtoType.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the tool. */ +export const CreateToolDraftDtoType = { + Dtmf: "dtmf", + EndCall: "endCall", + KnowledgeBase: "knowledgeBase", + TransferCall: "transferCall", + TransferCancel: "transferCancel", + TransferSuccessful: "transferSuccessful", + Handoff: "handoff", + Output: "output", + Voicemail: "voicemail", + Query: "query", + Sms: "sms", + SipRequest: "sipRequest", + Function: "function", + Mcp: "mcp", + ApiRequest: "apiRequest", + Code: "code", + Bash: "bash", + Computer: "computer", + TextEditor: "textEditor", + GoogleCalendarEventCreate: "google.calendar.event.create", + GoogleCalendarAvailabilityCheck: "google.calendar.availability.check", + GoogleSheetsRowAppend: "google.sheets.row.append", + SlackMessageSend: "slack.message.send", + GohighlevelCalendarEventCreate: "gohighlevel.calendar.event.create", + GohighlevelCalendarAvailabilityCheck: "gohighlevel.calendar.availability.check", + GohighlevelContactCreate: "gohighlevel.contact.create", + GohighlevelContactGet: "gohighlevel.contact.get", + Make: "make", + Ghl: "ghl", +} as const; +export type CreateToolDraftDtoType = (typeof CreateToolDraftDtoType)[keyof typeof CreateToolDraftDtoType]; diff --git a/src/api/types/CreateToolDraftDtoVerb.ts b/src/api/types/CreateToolDraftDtoVerb.ts new file mode 100644 index 00000000..0724f20e --- /dev/null +++ b/src/api/types/CreateToolDraftDtoVerb.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the SIP method to send (sip-request tool). */ +export const CreateToolDraftDtoVerb = { + Info: "INFO", + Message: "MESSAGE", + Notify: "NOTIFY", +} as const; +export type CreateToolDraftDtoVerb = (typeof CreateToolDraftDtoVerb)[keyof typeof CreateToolDraftDtoVerb]; diff --git a/src/api/types/CreateToolTemplateDtoDetails.ts b/src/api/types/CreateToolTemplateDtoDetails.ts index 27274a27..04a126d3 100644 --- a/src/api/types/CreateToolTemplateDtoDetails.ts +++ b/src/api/types/CreateToolTemplateDtoDetails.ts @@ -119,4 +119,29 @@ export namespace CreateToolTemplateDtoDetails { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.CreateToolTemplateDtoDetails.ApiRequest + | Vapi.CreateToolTemplateDtoDetails.Bash + | Vapi.CreateToolTemplateDtoDetails.Code + | Vapi.CreateToolTemplateDtoDetails.Computer + | Vapi.CreateToolTemplateDtoDetails.Dtmf + | Vapi.CreateToolTemplateDtoDetails.EndCall + | Vapi.CreateToolTemplateDtoDetails.Function + | Vapi.CreateToolTemplateDtoDetails.GohighlevelCalendarAvailabilityCheck + | Vapi.CreateToolTemplateDtoDetails.GohighlevelCalendarEventCreate + | Vapi.CreateToolTemplateDtoDetails.GohighlevelContactCreate + | Vapi.CreateToolTemplateDtoDetails.GohighlevelContactGet + | Vapi.CreateToolTemplateDtoDetails.GoogleCalendarAvailabilityCheck + | Vapi.CreateToolTemplateDtoDetails.GoogleCalendarEventCreate + | Vapi.CreateToolTemplateDtoDetails.GoogleSheetsRowAppend + | Vapi.CreateToolTemplateDtoDetails.Handoff + | Vapi.CreateToolTemplateDtoDetails.Mcp + | Vapi.CreateToolTemplateDtoDetails.Query + | Vapi.CreateToolTemplateDtoDetails.SlackMessageSend + | Vapi.CreateToolTemplateDtoDetails.Sms + | Vapi.CreateToolTemplateDtoDetails.TextEditor + | Vapi.CreateToolTemplateDtoDetails.TransferCall + | Vapi.CreateToolTemplateDtoDetails.SipRequest + | Vapi.CreateToolTemplateDtoDetails.Voicemail; } diff --git a/src/api/types/CreateTransferCallToolDto.ts b/src/api/types/CreateTransferCallToolDto.ts index 810db8ef..1d702d19 100644 --- a/src/api/types/CreateTransferCallToolDto.ts +++ b/src/api/types/CreateTransferCallToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a tool that transfers the active call to one of its configured destinations. + */ export interface CreateTransferCallToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateTransferCallToolDtoMessagesItem[] | undefined; /** 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. */ destinations?: Vapi.CreateTransferCallToolDtoDestinationsItem[] | undefined; diff --git a/src/api/types/CreateTrieveCredentialDto.ts b/src/api/types/CreateTrieveCredentialDto.ts index 00760cb6..806df9d8 100644 --- a/src/api/types/CreateTrieveCredentialDto.ts +++ b/src/api/types/CreateTrieveCredentialDto.ts @@ -1,8 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating knowledge-base requests with Trieve. + */ export interface CreateTrieveCredentialDto { - /** This is not returned in the API. */ - apiKey: string; - /** This is the name of credential. This is just for your reference. */ - name?: string | undefined; + /** Selects Trieve as the credential provider. */ + provider?: unknown | undefined; } diff --git a/src/api/types/CreateTrieveKnowledgeBaseDto.ts b/src/api/types/CreateTrieveKnowledgeBaseDto.ts index 4040d87e..8e7d365c 100644 --- a/src/api/types/CreateTrieveKnowledgeBaseDto.ts +++ b/src/api/types/CreateTrieveKnowledgeBaseDto.ts @@ -1,24 +1,3 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; - -export interface CreateTrieveKnowledgeBaseDto { - /** - * This knowledge base is provided by Trieve. - * - * To learn more about Trieve, visit https://trieve.ai. - */ - provider: Vapi.CreateTrieveKnowledgeBaseDtoProvider; - /** This is the name of the knowledge base. */ - name?: string | undefined; - /** - * This is the searching plan used when searching for relevant chunks from the vector store. - * - * You should configure this if you're running into these issues: - * - Too much unnecessary context is being fed as knowledge base context. - * - Not enough relevant context is being fed as knowledge base context. - */ - searchPlan?: Vapi.TrieveKnowledgeBaseSearchPlan | undefined; - /** This is the plan if you want us to create/import a new vector store using Trieve. */ - createPlan?: Vapi.TrieveKnowledgeBaseImport | undefined; -} +export type CreateTrieveKnowledgeBaseDto = unknown; diff --git a/src/api/types/CreateTrieveKnowledgeBaseDtoProvider.ts b/src/api/types/CreateTrieveKnowledgeBaseDtoProvider.ts deleted file mode 100644 index f5bb0948..00000000 --- a/src/api/types/CreateTrieveKnowledgeBaseDtoProvider.ts +++ /dev/null @@ -1,12 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** - * This knowledge base is provided by Trieve. - * - * To learn more about Trieve, visit https://trieve.ai. - */ -export const CreateTrieveKnowledgeBaseDtoProvider = { - Trieve: "trieve", -} as const; -export type CreateTrieveKnowledgeBaseDtoProvider = - (typeof CreateTrieveKnowledgeBaseDtoProvider)[keyof typeof CreateTrieveKnowledgeBaseDtoProvider]; diff --git a/src/api/types/CreateTwilioCredentialDto.ts b/src/api/types/CreateTwilioCredentialDto.ts index 7bb46111..dbf86f61 100644 --- a/src/api/types/CreateTwilioCredentialDto.ts +++ b/src/api/types/CreateTwilioCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API key credentials. + */ export interface CreateTwilioCredentialDto { /** This is not returned in the API. */ authToken?: string | undefined; @@ -7,6 +10,7 @@ export interface CreateTwilioCredentialDto { apiKey?: string | undefined; /** This is not returned in the API. */ apiSecret?: string | undefined; + /** Twilio Account SID associated with the credential. */ accountSid: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateTwilioPhoneNumberDto.ts b/src/api/types/CreateTwilioPhoneNumberDto.ts index 32790e71..b8f4d0e2 100644 --- a/src/api/types/CreateTwilioPhoneNumberDto.ts +++ b/src/api/types/CreateTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings. + */ export interface CreateTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateVapiPhoneNumberDto.ts b/src/api/types/CreateVapiPhoneNumberDto.ts index 5cb40bb9..8e5542e4 100644 --- a/src/api/types/CreateVapiPhoneNumberDto.ts +++ b/src/api/types/CreateVapiPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and authentication settings. + */ export interface CreateVapiPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateVoicemailToolDto.ts b/src/api/types/CreateVoicemailToolDto.ts index 1e5e3959..42cb86f3 100644 --- a/src/api/types/CreateVoicemailToolDto.ts +++ b/src/api/types/CreateVoicemailToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to create a voicemail-detection tool with optional beep detection for supported calls. + */ export interface CreateVoicemailToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.CreateVoicemailToolDtoMessagesItem[] | undefined; /** * This is the flag that enables beep detection for voicemail detection and applies only for twilio based calls. diff --git a/src/api/types/CreateVonageCredentialDto.ts b/src/api/types/CreateVonageCredentialDto.ts index 7f69272b..605cd49c 100644 --- a/src/api/types/CreateVonageCredentialDto.ts +++ b/src/api/types/CreateVonageCredentialDto.ts @@ -1,8 +1,12 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating telephony requests with Vonage. + */ export interface CreateVonageCredentialDto { /** This is not returned in the API. */ apiSecret: string; + /** Vonage API key associated with the credential. */ apiKey: string; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; diff --git a/src/api/types/CreateVonagePhoneNumberDto.ts b/src/api/types/CreateVonagePhoneNumberDto.ts index 9cf8016d..4caee3b6 100644 --- a/src/api/types/CreateVonagePhoneNumberDto.ts +++ b/src/api/types/CreateVonagePhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings. + */ export interface CreateVonagePhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/CreateWebCallDto.ts b/src/api/types/CreateWebCallDto.ts index 563beab8..f3d73618 100644 --- a/src/api/types/CreateWebCallDto.ts +++ b/src/api/types/CreateWebCallDto.ts @@ -3,6 +3,11 @@ import type * as Vapi from "../index.js"; export interface CreateWebCallDto { + /** + * This is the assistant version to use for this call. Supported only with + * direct `assistantId`. Omit to follow the latest version. + */ + assistantVersion?: (string | null) | undefined; roomDeleteOnUserLeaveEnabled?: boolean | undefined; /** * This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead. diff --git a/src/api/types/CreateWellSaidCredentialDto.ts b/src/api/types/CreateWellSaidCredentialDto.ts index e994f1e8..57f664bc 100644 --- a/src/api/types/CreateWellSaidCredentialDto.ts +++ b/src/api/types/CreateWellSaidCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating voice synthesis requests with WellSaid. + */ export interface CreateWellSaidCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CreateWorkflowDto.ts b/src/api/types/CreateWorkflowDto.ts index f3cb459f..3ce3d645 100644 --- a/src/api/types/CreateWorkflowDto.ts +++ b/src/api/types/CreateWorkflowDto.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for creating a graph-based workflow, including conversation and tool nodes, directed edges, global prompts, shared providers, hooks, credentials, and call behavior. + */ export interface CreateWorkflowDto { + /** Nodes that make up the workflow graph. Conversation nodes interact with the customer, while tool nodes invoke configured tools. */ nodes: Vapi.CreateWorkflowDtoNodesItem[]; /** * This is the model for the workflow. @@ -47,8 +51,11 @@ export interface CreateWorkflowDto { * Default is 1800 (30 minutes), max is 43200 (12 hours), and min is 10 seconds. */ maxDurationSeconds?: number | undefined; + /** Name used to identify the workflow. */ name: string; + /** Directed connections that determine transitions between nodes. */ edges: Vapi.Edge[]; + /** Prompt applied across the workflow's conversation nodes. */ globalPrompt?: string | undefined; /** * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. diff --git a/src/api/types/CreateWorkflowDtoCredentialsItem.ts b/src/api/types/CreateWorkflowDtoCredentialsItem.ts index 4b6e3318..ed6563ec 100644 --- a/src/api/types/CreateWorkflowDtoCredentialsItem.ts +++ b/src/api/types/CreateWorkflowDtoCredentialsItem.ts @@ -34,6 +34,7 @@ export type CreateWorkflowDtoCredentialsItem = | Vapi.CreateWorkflowDtoCredentialsItem.RimeAi | Vapi.CreateWorkflowDtoCredentialsItem.Runpod | Vapi.CreateWorkflowDtoCredentialsItem.S3 + | Vapi.CreateWorkflowDtoCredentialsItem.S3Compatible | Vapi.CreateWorkflowDtoCredentialsItem.Supabase | Vapi.CreateWorkflowDtoCredentialsItem.SmallestAi | Vapi.CreateWorkflowDtoCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type CreateWorkflowDtoCredentialsItem = | Vapi.CreateWorkflowDtoCredentialsItem.Webhook | Vapi.CreateWorkflowDtoCredentialsItem.CustomCredential | Vapi.CreateWorkflowDtoCredentialsItem.Xai + | Vapi.CreateWorkflowDtoCredentialsItem.Microsoft | Vapi.CreateWorkflowDtoCredentialsItem.Neuphonic | Vapi.CreateWorkflowDtoCredentialsItem.Hume | Vapi.CreateWorkflowDtoCredentialsItem.Mistral | Vapi.CreateWorkflowDtoCredentialsItem.Speechmatics | Vapi.CreateWorkflowDtoCredentialsItem.Soniox - | Vapi.CreateWorkflowDtoCredentialsItem.Trieve | Vapi.CreateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Client | Vapi.CreateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.CreateWorkflowDtoCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace CreateWorkflowDtoCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace CreateWorkflowDtoCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace CreateWorkflowDtoCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace CreateWorkflowDtoCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.CreateWorkflowDtoCredentialsItem._11Labs + | Vapi.CreateWorkflowDtoCredentialsItem.Anthropic + | Vapi.CreateWorkflowDtoCredentialsItem.AnthropicBedrock + | Vapi.CreateWorkflowDtoCredentialsItem.Anyscale + | Vapi.CreateWorkflowDtoCredentialsItem.AssemblyAi + | Vapi.CreateWorkflowDtoCredentialsItem.AzureOpenai + | Vapi.CreateWorkflowDtoCredentialsItem.Azure + | Vapi.CreateWorkflowDtoCredentialsItem.ByoSipTrunk + | Vapi.CreateWorkflowDtoCredentialsItem.Cartesia + | Vapi.CreateWorkflowDtoCredentialsItem.Cerebras + | Vapi.CreateWorkflowDtoCredentialsItem.Cloudflare + | Vapi.CreateWorkflowDtoCredentialsItem.CustomLlm + | Vapi.CreateWorkflowDtoCredentialsItem.Deepgram + | Vapi.CreateWorkflowDtoCredentialsItem.Deepinfra + | Vapi.CreateWorkflowDtoCredentialsItem.DeepSeek + | Vapi.CreateWorkflowDtoCredentialsItem.Gcp + | Vapi.CreateWorkflowDtoCredentialsItem.Gladia + | Vapi.CreateWorkflowDtoCredentialsItem.Gohighlevel + | Vapi.CreateWorkflowDtoCredentialsItem.Google + | Vapi.CreateWorkflowDtoCredentialsItem.Groq + | Vapi.CreateWorkflowDtoCredentialsItem.InflectionAi + | Vapi.CreateWorkflowDtoCredentialsItem.Langfuse + | Vapi.CreateWorkflowDtoCredentialsItem.Lmnt + | Vapi.CreateWorkflowDtoCredentialsItem.Make + | Vapi.CreateWorkflowDtoCredentialsItem.Openai + | Vapi.CreateWorkflowDtoCredentialsItem.Openrouter + | Vapi.CreateWorkflowDtoCredentialsItem.PerplexityAi + | Vapi.CreateWorkflowDtoCredentialsItem.Playht + | Vapi.CreateWorkflowDtoCredentialsItem.RimeAi + | Vapi.CreateWorkflowDtoCredentialsItem.Runpod + | Vapi.CreateWorkflowDtoCredentialsItem.S3 + | Vapi.CreateWorkflowDtoCredentialsItem.S3Compatible + | Vapi.CreateWorkflowDtoCredentialsItem.Supabase + | Vapi.CreateWorkflowDtoCredentialsItem.SmallestAi + | Vapi.CreateWorkflowDtoCredentialsItem.Tavus + | Vapi.CreateWorkflowDtoCredentialsItem.TogetherAi + | Vapi.CreateWorkflowDtoCredentialsItem.Twilio + | Vapi.CreateWorkflowDtoCredentialsItem.Vonage + | Vapi.CreateWorkflowDtoCredentialsItem.Webhook + | Vapi.CreateWorkflowDtoCredentialsItem.CustomCredential + | Vapi.CreateWorkflowDtoCredentialsItem.Xai + | Vapi.CreateWorkflowDtoCredentialsItem.Microsoft + | Vapi.CreateWorkflowDtoCredentialsItem.Neuphonic + | Vapi.CreateWorkflowDtoCredentialsItem.Hume + | Vapi.CreateWorkflowDtoCredentialsItem.Mistral + | Vapi.CreateWorkflowDtoCredentialsItem.Speechmatics + | Vapi.CreateWorkflowDtoCredentialsItem.Soniox + | Vapi.CreateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.CreateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.CreateWorkflowDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.CreateWorkflowDtoCredentialsItem.SlackOauth2Authorization + | Vapi.CreateWorkflowDtoCredentialsItem.GhlOauth2Authorization + | Vapi.CreateWorkflowDtoCredentialsItem.Inworld + | Vapi.CreateWorkflowDtoCredentialsItem.Minimax + | Vapi.CreateWorkflowDtoCredentialsItem.Wellsaid + | Vapi.CreateWorkflowDtoCredentialsItem.Email + | Vapi.CreateWorkflowDtoCredentialsItem.SlackWebhook; } diff --git a/src/api/types/CreateWorkflowDtoNodesItem.ts b/src/api/types/CreateWorkflowDtoNodesItem.ts index 9727e9a6..73333449 100644 --- a/src/api/types/CreateWorkflowDtoNodesItem.ts +++ b/src/api/types/CreateWorkflowDtoNodesItem.ts @@ -14,4 +14,6 @@ export namespace CreateWorkflowDtoNodesItem { export interface Tool extends Vapi.ToolNode { type: "tool"; } + + export type Response = Vapi.CreateWorkflowDtoNodesItem.Conversation | Vapi.CreateWorkflowDtoNodesItem.Tool; } diff --git a/src/api/types/CreateWorkflowDtoTranscriber.ts b/src/api/types/CreateWorkflowDtoTranscriber.ts index 85798331..cfe495b8 100644 --- a/src/api/types/CreateWorkflowDtoTranscriber.ts +++ b/src/api/types/CreateWorkflowDtoTranscriber.ts @@ -19,7 +19,9 @@ export type CreateWorkflowDtoTranscriber = | Vapi.CreateWorkflowDtoTranscriber.Talkscriber | Vapi.CreateWorkflowDtoTranscriber.Openai | Vapi.CreateWorkflowDtoTranscriber.Cartesia - | Vapi.CreateWorkflowDtoTranscriber.Soniox; + | Vapi.CreateWorkflowDtoTranscriber.Soniox + | Vapi.CreateWorkflowDtoTranscriber.Xai + | Vapi.CreateWorkflowDtoTranscriber.Vapi; export namespace CreateWorkflowDtoTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -69,4 +71,12 @@ export namespace CreateWorkflowDtoTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/CreateWorkflowDtoVoice.ts b/src/api/types/CreateWorkflowDtoVoice.ts index d0e61d25..b625b658 100644 --- a/src/api/types/CreateWorkflowDtoVoice.ts +++ b/src/api/types/CreateWorkflowDtoVoice.ts @@ -25,7 +25,9 @@ export type CreateWorkflowDtoVoice = | Vapi.CreateWorkflowDtoVoice.Vapi | Vapi.CreateWorkflowDtoVoice.Sesame | Vapi.CreateWorkflowDtoVoice.Inworld - | Vapi.CreateWorkflowDtoVoice.Minimax; + | Vapi.CreateWorkflowDtoVoice.Minimax + | Vapi.CreateWorkflowDtoVoice.Xai + | Vapi.CreateWorkflowDtoVoice.Microsoft; export namespace CreateWorkflowDtoVoice { export interface Azure extends Vapi.AzureVoice { @@ -99,4 +101,12 @@ export namespace CreateWorkflowDtoVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/CreateXAiCredentialDto.ts b/src/api/types/CreateXAiCredentialDto.ts index 83c372af..9bc3fafe 100644 --- a/src/api/types/CreateXAiCredentialDto.ts +++ b/src/api/types/CreateXAiCredentialDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Credentials for authenticating assistant model requests with xAI. + */ export interface CreateXAiCredentialDto { /** This is not returned in the API. */ apiKey: string; diff --git a/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts b/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts index 5fd31689..36cb519d 100644 --- a/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts +++ b/src/api/types/CustomEndpointingModelSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using a custom endpointing model, including its provider identifier and server connection. + */ export interface CustomEndpointingModelSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. Use `custom-endpointing-model` for custom endpointing providers that are not natively supported. */ provider: Vapi.CustomEndpointingModelSmartEndpointingPlanProvider; diff --git a/src/api/types/CustomLlmModel.ts b/src/api/types/CustomLlmModel.ts index 7fb421a0..ec8b9017 100644 --- a/src/api/types/CustomLlmModel.ts +++ b/src/api/types/CustomLlmModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses through a custom language model endpoint, including server URL, headers, metadata, prompts, tools, and generation settings. + */ export interface CustomLlmModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,6 +20,13 @@ export interface CustomLlmModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** @@ -44,7 +54,7 @@ export interface CustomLlmModel { timeoutSeconds?: number | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/CustomLlmModelToolsItem.ts b/src/api/types/CustomLlmModelToolsItem.ts index cbaa7b1a..a8c5a9c6 100644 --- a/src/api/types/CustomLlmModelToolsItem.ts +++ b/src/api/types/CustomLlmModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace CustomLlmModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.CustomLlmModelToolsItem.ApiRequest + | Vapi.CustomLlmModelToolsItem.Bash + | Vapi.CustomLlmModelToolsItem.Code + | Vapi.CustomLlmModelToolsItem.Computer + | Vapi.CustomLlmModelToolsItem.Dtmf + | Vapi.CustomLlmModelToolsItem.EndCall + | Vapi.CustomLlmModelToolsItem.Function + | Vapi.CustomLlmModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.CustomLlmModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.CustomLlmModelToolsItem.GohighlevelContactCreate + | Vapi.CustomLlmModelToolsItem.GohighlevelContactGet + | Vapi.CustomLlmModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.CustomLlmModelToolsItem.GoogleCalendarEventCreate + | Vapi.CustomLlmModelToolsItem.GoogleSheetsRowAppend + | Vapi.CustomLlmModelToolsItem.Handoff + | Vapi.CustomLlmModelToolsItem.Mcp + | Vapi.CustomLlmModelToolsItem.Query + | Vapi.CustomLlmModelToolsItem.SlackMessageSend + | Vapi.CustomLlmModelToolsItem.Sms + | Vapi.CustomLlmModelToolsItem.TextEditor + | Vapi.CustomLlmModelToolsItem.TransferCall + | Vapi.CustomLlmModelToolsItem.SipRequest + | Vapi.CustomLlmModelToolsItem.Voicemail; } diff --git a/src/api/types/CustomMessage.ts b/src/api/types/CustomMessage.ts index 01ed175e..a32072c1 100644 --- a/src/api/types/CustomMessage.ts +++ b/src/api/types/CustomMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A message spoken by the assistant with optional language-specific content variants. + */ export interface CustomMessage { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/CustomTranscriber.ts b/src/api/types/CustomTranscriber.ts index 44b77b9e..479a76c7 100644 --- a/src/api/types/CustomTranscriber.ts +++ b/src/api/types/CustomTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for sending conversation audio to a custom WebSocket transcription server. + */ export interface CustomTranscriber { /** * This is where the transcription request will be sent. diff --git a/src/api/types/CustomVoice.ts b/src/api/types/CustomVoice.ts index 54db4240..06ef0ec4 100644 --- a/src/api/types/CustomVoice.ts +++ b/src/api/types/CustomVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, caching, and fallback settings. + */ export interface CustomVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/CustomerCustomEndpointingRule.ts b/src/api/types/CustomerCustomEndpointingRule.ts index c80a6c7b..fe96cc06 100644 --- a/src/api/types/CustomerCustomEndpointingRule.ts +++ b/src/api/types/CustomerCustomEndpointingRule.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A custom endpointing rule that matches the customer's current speech and applies a configured timeout. + */ export interface CustomerCustomEndpointingRule { /** * This is the regex pattern to match. diff --git a/src/api/types/CustomerSpeechTimeoutOptions.ts b/src/api/types/CustomerSpeechTimeoutOptions.ts index bf959975..87c5bd99 100644 --- a/src/api/types/CustomerSpeechTimeoutOptions.ts +++ b/src/api/types/CustomerSpeechTimeoutOptions.ts @@ -1,11 +1,20 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets. + */ export interface CustomerSpeechTimeoutOptions { + /** Controls whether the hook's trigger counter resets after the customer speaks. Defaults to `never`. */ + triggerResetMode?: Vapi.CustomerSpeechTimeoutOptionsTriggerResetMode | undefined; /** * This is the timeout in seconds before action is triggered. * The clock starts when the assistant finishes speaking and remains active until the user speaks. * * @default 7.5 + * @minimum 2 + * @maximum 1000 */ timeoutSeconds: number; /** @@ -14,10 +23,4 @@ export interface CustomerSpeechTimeoutOptions { * @default 3 */ triggerMaxCount?: number | undefined; - /** - * This is whether the counter for hook trigger resets the user speaks. - * - * @default never - */ - triggerResetMode?: Record | undefined; } diff --git a/src/api/types/CustomerSpeechTimeoutOptionsTriggerResetMode.ts b/src/api/types/CustomerSpeechTimeoutOptionsTriggerResetMode.ts new file mode 100644 index 00000000..cc9be471 --- /dev/null +++ b/src/api/types/CustomerSpeechTimeoutOptionsTriggerResetMode.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Controls whether the hook's trigger counter resets after the customer speaks. Defaults to `never`. */ +export const CustomerSpeechTimeoutOptionsTriggerResetMode = { + OnUserSpeech: "onUserSpeech", + Never: "never", +} as const; +export type CustomerSpeechTimeoutOptionsTriggerResetMode = + (typeof CustomerSpeechTimeoutOptionsTriggerResetMode)[keyof typeof CustomerSpeechTimeoutOptionsTriggerResetMode]; diff --git a/src/api/types/DeepInfraModel.ts b/src/api/types/DeepInfraModel.ts index 46b48b0f..f5b6d94b 100644 --- a/src/api/types/DeepInfraModel.ts +++ b/src/api/types/DeepInfraModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface DeepInfraModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface DeepInfraModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/DeepInfraModelToolsItem.ts b/src/api/types/DeepInfraModelToolsItem.ts index cccf7477..15a418c3 100644 --- a/src/api/types/DeepInfraModelToolsItem.ts +++ b/src/api/types/DeepInfraModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace DeepInfraModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.DeepInfraModelToolsItem.ApiRequest + | Vapi.DeepInfraModelToolsItem.Bash + | Vapi.DeepInfraModelToolsItem.Code + | Vapi.DeepInfraModelToolsItem.Computer + | Vapi.DeepInfraModelToolsItem.Dtmf + | Vapi.DeepInfraModelToolsItem.EndCall + | Vapi.DeepInfraModelToolsItem.Function + | Vapi.DeepInfraModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.DeepInfraModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.DeepInfraModelToolsItem.GohighlevelContactCreate + | Vapi.DeepInfraModelToolsItem.GohighlevelContactGet + | Vapi.DeepInfraModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.DeepInfraModelToolsItem.GoogleCalendarEventCreate + | Vapi.DeepInfraModelToolsItem.GoogleSheetsRowAppend + | Vapi.DeepInfraModelToolsItem.Handoff + | Vapi.DeepInfraModelToolsItem.Mcp + | Vapi.DeepInfraModelToolsItem.Query + | Vapi.DeepInfraModelToolsItem.SlackMessageSend + | Vapi.DeepInfraModelToolsItem.Sms + | Vapi.DeepInfraModelToolsItem.TextEditor + | Vapi.DeepInfraModelToolsItem.TransferCall + | Vapi.DeepInfraModelToolsItem.SipRequest + | Vapi.DeepInfraModelToolsItem.Voicemail; } diff --git a/src/api/types/DeepSeekModel.ts b/src/api/types/DeepSeekModel.ts index 1852108d..3342f62f 100644 --- a/src/api/types/DeepSeekModel.ts +++ b/src/api/types/DeepSeekModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface DeepSeekModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface DeepSeekModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.DeepSeekModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/DeepSeekModelToolsItem.ts b/src/api/types/DeepSeekModelToolsItem.ts index 5f3a03cc..54109f92 100644 --- a/src/api/types/DeepSeekModelToolsItem.ts +++ b/src/api/types/DeepSeekModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace DeepSeekModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.DeepSeekModelToolsItem.ApiRequest + | Vapi.DeepSeekModelToolsItem.Bash + | Vapi.DeepSeekModelToolsItem.Code + | Vapi.DeepSeekModelToolsItem.Computer + | Vapi.DeepSeekModelToolsItem.Dtmf + | Vapi.DeepSeekModelToolsItem.EndCall + | Vapi.DeepSeekModelToolsItem.Function + | Vapi.DeepSeekModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.DeepSeekModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.DeepSeekModelToolsItem.GohighlevelContactCreate + | Vapi.DeepSeekModelToolsItem.GohighlevelContactGet + | Vapi.DeepSeekModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.DeepSeekModelToolsItem.GoogleCalendarEventCreate + | Vapi.DeepSeekModelToolsItem.GoogleSheetsRowAppend + | Vapi.DeepSeekModelToolsItem.Handoff + | Vapi.DeepSeekModelToolsItem.Mcp + | Vapi.DeepSeekModelToolsItem.Query + | Vapi.DeepSeekModelToolsItem.SlackMessageSend + | Vapi.DeepSeekModelToolsItem.Sms + | Vapi.DeepSeekModelToolsItem.TextEditor + | Vapi.DeepSeekModelToolsItem.TransferCall + | Vapi.DeepSeekModelToolsItem.SipRequest + | Vapi.DeepSeekModelToolsItem.Voicemail; } diff --git a/src/api/types/DeepgramTranscriber.ts b/src/api/types/DeepgramTranscriber.ts index 48d46995..5c02023e 100644 --- a/src/api/types/DeepgramTranscriber.ts +++ b/src/api/types/DeepgramTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, formatting, endpointing, vocabulary, and fallback settings. + */ export interface DeepgramTranscriber { /** This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview */ model?: Vapi.DeepgramTranscriberModel | undefined; @@ -29,14 +32,27 @@ export interface DeepgramTranscriber { * @default false */ profanityFilter?: boolean | undefined; + /** + * Enables redaction of sensitive information from transcripts. + * + * Options include: + * - "pci": Redacts credit card numbers, expiration dates, and CVV. + * - "pii": Redacts personally identifiable information (names, locations, identifying numbers, etc.). + * - "phi": Redacts protected health information (medical conditions, drugs, injuries, etc.). + * - "numbers": Redacts numerical and identifying entities (dates, account numbers, SSNs, etc.). + * + * Multiple values can be provided to redact different categories simultaneously. + * Redacted content is replaced with entity labels like [CREDIT_CARD_1], [SSN_1], etc. + * + * See https://developers.deepgram.com/docs/redaction for details. + */ + redaction?: Vapi.DeepgramTranscriberRedactionItem[] | undefined; /** * Transcripts below this confidence threshold will be discarded. * * @default 0.4 */ confidenceThreshold?: number | undefined; - /** Eager end-of-turn confidence required to fire a eager end-of-turn event. Setting a value here will enable EagerEndOfTurn and SpeechResumed events. It is disabled by default. Only used with Flux models. */ - eagerEotThreshold?: number | undefined; /** * End-of-turn confidence required to finish a turn. Only used with Flux models. * @@ -49,6 +65,12 @@ export interface DeepgramTranscriber { * @default 5000 */ eotTimeoutMs?: number | undefined; + /** + * Language hints to bias Flux Multilingual (`flux-general-multi`) toward specific languages. + * Provide BCP-47 language codes (e.g. "en", "es", "fr"). Multiple hints can be given for + * multilingual or code-switching scenarios. Omit for auto-detection. Only used with `flux-general-multi`. + */ + languages?: string[] | undefined; /** These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here. */ keywords?: string[] | undefined; /** Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%. */ diff --git a/src/api/types/DeepgramTranscriberRedactionItem.ts b/src/api/types/DeepgramTranscriberRedactionItem.ts new file mode 100644 index 00000000..131603ad --- /dev/null +++ b/src/api/types/DeepgramTranscriberRedactionItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export const DeepgramTranscriberRedactionItem = { + Pci: "pci", + Pii: "pii", + Phi: "phi", + Numbers: "numbers", +} as const; +export type DeepgramTranscriberRedactionItem = + (typeof DeepgramTranscriberRedactionItem)[keyof typeof DeepgramTranscriberRedactionItem]; diff --git a/src/api/types/DeepgramVoice.ts b/src/api/types/DeepgramVoice.ts index 77c39858..db48fd8d 100644 --- a/src/api/types/DeepgramVoice.ts +++ b/src/api/types/DeepgramVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, caching, and fallback settings. + */ export interface DeepgramVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/DeepgramVoiceId.ts b/src/api/types/DeepgramVoiceId.ts index 423db662..f11d18ad 100644 --- a/src/api/types/DeepgramVoiceId.ts +++ b/src/api/types/DeepgramVoiceId.ts @@ -57,5 +57,12 @@ export const DeepgramVoiceId = { Aquila: "aquila", Selena: "selena", Javier: "javier", + Viktoria: "viktoria", + Kara: "kara", + Fabian: "fabian", + Julius: "julius", + Lara: "lara", + Elara: "elara", + Aurelia: "aurelia", } as const; export type DeepgramVoiceId = (typeof DeepgramVoiceId)[keyof typeof DeepgramVoiceId]; diff --git a/src/api/types/DeveloperMessage.ts b/src/api/types/DeveloperMessage.ts index 9b248909..9ea236a7 100644 --- a/src/api/types/DeveloperMessage.ts +++ b/src/api/types/DeveloperMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A developer-authored instruction message supplied to the language model. + */ export interface DeveloperMessage { /** This is the role of the message author */ role: Vapi.DeveloperMessageRole; diff --git a/src/api/types/DialPlanEntry.ts b/src/api/types/DialPlanEntry.ts index c1557164..4a3462c9 100644 --- a/src/api/types/DialPlanEntry.ts +++ b/src/api/types/DialPlanEntry.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Associates a phone number with the customers to dial through that number in a batch call plan. + */ export interface DialPlanEntry { /** The phone number ID to use for calling the customers in this entry. */ phoneNumberId: string; diff --git a/src/api/types/DtmfTool.ts b/src/api/types/DtmfTool.ts index 60393a7e..724d7e06 100644 --- a/src/api/types/DtmfTool.ts +++ b/src/api/types/DtmfTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send DTMF keypad tones during a call. + */ export interface DtmfTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.DtmfToolMessagesItem[] | undefined; /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833 (RTP events). When enabled, DTMF digits will be sent using the SIP INFO method, which can be more reliable in some network configurations. Only relevant when using the `vapi.sip` transport. */ sipInfoDtmfEnabled?: boolean | undefined; diff --git a/src/api/types/Edge.ts b/src/api/types/Edge.ts index 3a3a65f5..3136f5a1 100644 --- a/src/api/types/Edge.ts +++ b/src/api/types/Edge.ts @@ -2,9 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A directed connection between two workflow nodes, with an optional AI-evaluated transition condition. + */ export interface Edge { + /** Condition that must evaluate to true to follow this edge. */ condition?: Vapi.AiEdgeCondition | undefined; + /** Name of the source workflow node. */ from: string; + /** Name of the destination workflow node. */ to: string; /** This is for metadata you want to store on the edge. */ metadata?: Record | undefined; diff --git a/src/api/types/ElevenLabsCredential.ts b/src/api/types/ElevenLabsCredential.ts index de96b0d3..e4d24c6c 100644 --- a/src/api/types/ElevenLabsCredential.ts +++ b/src/api/types/ElevenLabsCredential.ts @@ -1,9 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface ElevenLabsCredential { provider: "11labs"; /** This is not returned in the API. */ apiKey: string; + /** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ + apiUrl?: (Vapi.ElevenLabsCredentialApiUrl | null) | undefined; /** This is the unique identifier for the credential. */ id: string; /** This is the unique identifier for the org that this credential belongs to. */ diff --git a/src/api/types/ElevenLabsCredentialApiUrl.ts b/src/api/types/ElevenLabsCredentialApiUrl.ts new file mode 100644 index 00000000..46ef9a1a --- /dev/null +++ b/src/api/types/ElevenLabsCredentialApiUrl.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ +export const ElevenLabsCredentialApiUrl = { + HttpsApiElevenlabsIo: "https://api.elevenlabs.io", + HttpsApiEuResidencyElevenlabsIo: "https://api.eu.residency.elevenlabs.io", +} as const; +export type ElevenLabsCredentialApiUrl = (typeof ElevenLabsCredentialApiUrl)[keyof typeof ElevenLabsCredentialApiUrl]; diff --git a/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts b/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts index 7cb431fa..bc8e07a6 100644 --- a/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts +++ b/src/api/types/ElevenLabsPronunciationDictionaryLocator.ts @@ -1,8 +1,15 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Identifies a specific version of an ElevenLabs pronunciation dictionary. + */ export interface ElevenLabsPronunciationDictionaryLocator { /** This is the ID of the pronunciation dictionary to use. */ pronunciationDictionaryId: string; - /** This is the version ID of the pronunciation dictionary to use. */ - versionId: string; + /** + * This is the version ID of the pronunciation dictionary to use. + * + * Omit to use the dictionary's latest version. + */ + versionId?: string | undefined; } diff --git a/src/api/types/ElevenLabsTranscriber.ts b/src/api/types/ElevenLabsTranscriber.ts index c377e99c..10d22dbe 100644 --- a/src/api/types/ElevenLabsTranscriber.ts +++ b/src/api/types/ElevenLabsTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, speech thresholds, and fallback settings. + */ export interface ElevenLabsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.ElevenLabsTranscriberModel | undefined; diff --git a/src/api/types/ElevenLabsVoice.ts b/src/api/types/ElevenLabsVoice.ts index b116e8cb..65904663 100644 --- a/src/api/types/ElevenLabsVoice.ts +++ b/src/api/types/ElevenLabsVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, caching, and fallback settings. + */ export interface ElevenLabsVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/EndCallTool.ts b/src/api/types/EndCallTool.ts index 03a61d4b..12763c66 100644 --- a/src/api/types/EndCallTool.ts +++ b/src/api/types/EndCallTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant end the active call. + */ export interface EndCallTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.EndCallToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/EndedReasonCondition.ts b/src/api/types/EndedReasonCondition.ts new file mode 100644 index 00000000..641205c7 --- /dev/null +++ b/src/api/types/EndedReasonCondition.ts @@ -0,0 +1,20 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface EndedReasonCondition { + /** + * This is the membership operator applied against `values`. + * + * - 'oneOf': the structured output runs only if the call's ended reason is in `values`. + * - 'notOneOf': the structured output runs only if the call's ended reason is NOT in `values`. + */ + operator: Vapi.EndedReasonConditionOperator; + /** + * These are the ended reasons compared against the call's ended reason. + * + * Any string is accepted so configurations never break when new ended + * reasons are introduced. Must contain at least one value. + */ + values: string[]; +} diff --git a/src/api/types/EndedReasonConditionOperator.ts b/src/api/types/EndedReasonConditionOperator.ts new file mode 100644 index 00000000..5edb772b --- /dev/null +++ b/src/api/types/EndedReasonConditionOperator.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the membership operator applied against `values`. + * + * - 'oneOf': the structured output runs only if the call's ended reason is in `values`. + * - 'notOneOf': the structured output runs only if the call's ended reason is NOT in `values`. + */ +export const EndedReasonConditionOperator = { + OneOf: "oneOf", + NotOneOf: "notOneOf", +} as const; +export type EndedReasonConditionOperator = + (typeof EndedReasonConditionOperator)[keyof typeof EndedReasonConditionOperator]; diff --git a/src/api/types/Eval.ts b/src/api/types/Eval.ts index d1b7f795..45527ae6 100644 --- a/src/api/types/Eval.ts +++ b/src/api/types/Eval.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle information. + */ export interface Eval { /** * This is the mock conversation that will be used to evaluate the flow of the conversation. @@ -11,9 +14,13 @@ export interface Eval { * Evaluation Messages are used as checkpoints in the flow where the model's response to previous conversation needs to be evaluated to check the content and tool calls */ messages: Vapi.EvalMessagesItem[]; + /** The unique identifier for the eval. */ id: string; + /** The unique identifier for the organization that owns the eval. */ orgId: string; + /** The ISO 8601 timestamp when the eval was created. */ createdAt: string; + /** The ISO 8601 timestamp when the eval was last updated. */ updatedAt: string; /** * This is the name of the eval. diff --git a/src/api/types/EvalAnthropicModel.ts b/src/api/types/EvalAnthropicModel.ts index 72f8a322..3d30c6aa 100644 --- a/src/api/types/EvalAnthropicModel.ts +++ b/src/api/types/EvalAnthropicModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended thinking. + */ export interface EvalAnthropicModel { /** This is the specific model that will be used. */ model: Vapi.EvalAnthropicModelModel; diff --git a/src/api/types/EvalAnthropicModelModel.ts b/src/api/types/EvalAnthropicModelModel.ts index 9787f3da..44ef17f2 100644 --- a/src/api/types/EvalAnthropicModelModel.ts +++ b/src/api/types/EvalAnthropicModelModel.ts @@ -15,6 +15,7 @@ export const EvalAnthropicModelModel = { ClaudeSonnet420250514: "claude-sonnet-4-20250514", ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929", ClaudeSonnet46: "claude-sonnet-4-6", + ClaudeSonnet5: "claude-sonnet-5", ClaudeHaiku4520251001: "claude-haiku-4-5-20251001", } as const; export type EvalAnthropicModelModel = (typeof EvalAnthropicModelModel)[keyof typeof EvalAnthropicModelModel]; diff --git a/src/api/types/EvalCustomModel.ts b/src/api/types/EvalCustomModel.ts index 53e31047..3e043058 100644 --- a/src/api/types/EvalCustomModel.ts +++ b/src/api/types/EvalCustomModel.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and generation settings. + */ export interface EvalCustomModel { /** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */ url: string; diff --git a/src/api/types/EvalGoogleModel.ts b/src/api/types/EvalGoogleModel.ts index fd0d5148..20b28f3a 100644 --- a/src/api/types/EvalGoogleModel.ts +++ b/src/api/types/EvalGoogleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Google model configuration for an LLM judge, including its messages and generation settings. + */ export interface EvalGoogleModel { /** This is the name of the model. Ex. gpt-4o */ model: Vapi.EvalGoogleModelModel; diff --git a/src/api/types/EvalGoogleModelModel.ts b/src/api/types/EvalGoogleModelModel.ts index c566baf4..499c5118 100644 --- a/src/api/types/EvalGoogleModelModel.ts +++ b/src/api/types/EvalGoogleModelModel.ts @@ -2,6 +2,8 @@ /** This is the name of the model. Ex. gpt-4o */ export const EvalGoogleModelModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/EvalGroqModelModel.ts b/src/api/types/EvalGroqModelModel.ts index 2e387a94..94c649d8 100644 --- a/src/api/types/EvalGroqModelModel.ts +++ b/src/api/types/EvalGroqModelModel.ts @@ -12,7 +12,6 @@ export const EvalGroqModelModel = { Llama370B8192: "llama3-70b-8192", Gemma29BIt: "gemma2-9b-it", MoonshotaiKimiK2Instruct0905: "moonshotai/kimi-k2-instruct-0905", - MetaLlamaLlama4Maverick17B128EInstruct: "meta-llama/llama-4-maverick-17b-128e-instruct", MetaLlamaLlama4Scout17B16EInstruct: "meta-llama/llama-4-scout-17b-16e-instruct", MistralSaba24B: "mistral-saba-24b", CompoundBeta: "compound-beta", diff --git a/src/api/types/EvalOpenAiModel.ts b/src/api/types/EvalOpenAiModel.ts index 1c6121b2..d0a8f7f6 100644 --- a/src/api/types/EvalOpenAiModel.ts +++ b/src/api/types/EvalOpenAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * OpenAI model configuration for an LLM judge, including its messages and generation settings. + */ export interface EvalOpenAiModel { /** * This is the OpenAI model that will be used. diff --git a/src/api/types/EvalOpenAiModelModel.ts b/src/api/types/EvalOpenAiModelModel.ts index 57af8385..56963095 100644 --- a/src/api/types/EvalOpenAiModelModel.ts +++ b/src/api/types/EvalOpenAiModelModel.ts @@ -7,6 +7,11 @@ * This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/. */ export const EvalOpenAiModelModel = { + Gpt56Sol: "gpt-5.6-sol", + Gpt56Terra: "gpt-5.6-terra", + Gpt56Luna: "gpt-5.6-luna", + Gpt55: "gpt-5.5", + ChatLatest: "chat-latest", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -48,6 +53,35 @@ export const EvalOpenAiModelModel = { Gpt35Turbo1106: "gpt-3.5-turbo-1106", Gpt35Turbo16K: "gpt-3.5-turbo-16k", Gpt35Turbo0613: "gpt-3.5-turbo-0613", + Gpt56LunaWestus3: "gpt-5.6-luna:westus3", + Gpt56TerraWestus3: "gpt-5.6-terra:westus3", + Gpt56SolWestus3: "gpt-5.6-sol:westus3", + Gpt54Eastus2: "gpt-5.4:eastus2", + Gpt54Swedencentral: "gpt-5.4:swedencentral", + Gpt54MiniEastus2: "gpt-5.4-mini:eastus2", + Gpt54MiniSwedencentral: "gpt-5.4-mini:swedencentral", + Gpt54NanoEastus2: "gpt-5.4-nano:eastus2", + Gpt54NanoSwedencentral: "gpt-5.4-nano:swedencentral", + Gpt52Eastus2: "gpt-5.2:eastus2", + Gpt52Swedencentral: "gpt-5.2:swedencentral", + Gpt51Eastus2: "gpt-5.1:eastus2", + Gpt51Swedencentral: "gpt-5.1:swedencentral", + Gpt5Eastus2: "gpt-5:eastus2", + Gpt5Swedencentral: "gpt-5:swedencentral", + Gpt5Canadaeast: "gpt-5:canadaeast", + Gpt5Eastus: "gpt-5:eastus", + Gpt5Westeurope: "gpt-5:westeurope", + Gpt5Germanywestcentral: "gpt-5:germanywestcentral", + Gpt5Polandcentral: "gpt-5:polandcentral", + Gpt5Spaincentral: "gpt-5:spaincentral", + Gpt5MiniEastus2: "gpt-5-mini:eastus2", + Gpt5MiniSwedencentral: "gpt-5-mini:swedencentral", + Gpt5MiniWesteurope: "gpt-5-mini:westeurope", + Gpt5MiniGermanywestcentral: "gpt-5-mini:germanywestcentral", + Gpt5MiniPolandcentral: "gpt-5-mini:polandcentral", + Gpt5MiniSpaincentral: "gpt-5-mini:spaincentral", + Gpt5NanoEastus2: "gpt-5-nano:eastus2", + Gpt5NanoSwedencentral: "gpt-5-nano:swedencentral", Gpt4120250414Westus: "gpt-4.1-2025-04-14:westus", Gpt4120250414Eastus2: "gpt-4.1-2025-04-14:eastus2", Gpt4120250414Eastus: "gpt-4.1-2025-04-14:eastus", @@ -120,5 +154,8 @@ export const EvalOpenAiModelModel = { Gpt35Turbo0125Southcentralus: "gpt-3.5-turbo-0125:southcentralus", Gpt35Turbo1106Canadaeast: "gpt-3.5-turbo-1106:canadaeast", Gpt35Turbo1106Westus: "gpt-3.5-turbo-1106:westus", + Gpt41Australiaeast: "gpt-4.1:australiaeast", + Gpt4OAustraliaeast: "gpt-4o:australiaeast", + Gpt54MiniAustraliaeast: "gpt-5.4-mini:australiaeast", } as const; export type EvalOpenAiModelModel = (typeof EvalOpenAiModelModel)[keyof typeof EvalOpenAiModelModel]; diff --git a/src/api/types/EvalPaginatedResponse.ts b/src/api/types/EvalPaginatedResponse.ts index 7795aece..d30b65b9 100644 --- a/src/api/types/EvalPaginatedResponse.ts +++ b/src/api/types/EvalPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of saved eval definitions and metadata describing the result set. + */ export interface EvalPaginatedResponse { + /** The eval definitions returned for the current page. */ results: Vapi.Eval[]; + /** Pagination metadata for the eval result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/EvalRun.ts b/src/api/types/EvalRun.ts index e86cc063..3c62654a 100644 --- a/src/api/types/EvalRun.ts +++ b/src/api/types/EvalRun.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle timestamps. + */ export interface EvalRun { /** * This is the status of the eval run. When an eval run is created, the status is 'running'. @@ -21,10 +24,15 @@ export interface EvalRun { eval?: Vapi.CreateEvalDto | undefined; /** This is the target that will be run against the eval */ target: Vapi.EvalRunTarget; + /** The unique identifier for the eval run. */ id: string; + /** The unique identifier for the organization that owns the run. */ orgId: string; + /** The ISO 8601 timestamp when the eval run was created. */ createdAt: string; + /** The ISO 8601 timestamp when the eval run started. */ startedAt: string; + /** The ISO 8601 timestamp when the eval run ended. */ endedAt: string; /** This is the ended message when the eval run ended for any reason apart from mockConversation.done */ endedMessage?: string | undefined; diff --git a/src/api/types/EvalRunPaginatedResponse.ts b/src/api/types/EvalRunPaginatedResponse.ts index 0bf7ef2e..c11bde35 100644 --- a/src/api/types/EvalRunPaginatedResponse.ts +++ b/src/api/types/EvalRunPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of eval runs and metadata describing the result set. + */ export interface EvalRunPaginatedResponse { + /** The eval runs returned for the current page. */ results: Vapi.EvalRun[]; + /** Pagination metadata for the eval-run result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/EvalRunResult.ts b/src/api/types/EvalRunResult.ts index 28f16977..778d0286 100644 --- a/src/api/types/EvalRunResult.ts +++ b/src/api/types/EvalRunResult.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * The pass or fail result of an evaluation run, including its conversation messages and timing. + */ export interface EvalRunResult { /** * This is the status of the eval run result. diff --git a/src/api/types/EvalRunTarget.ts b/src/api/types/EvalRunTarget.ts index 69651133..7447d08a 100644 --- a/src/api/types/EvalRunTarget.ts +++ b/src/api/types/EvalRunTarget.ts @@ -15,4 +15,9 @@ export namespace EvalRunTarget { export interface Squad extends Vapi.EvalRunTargetSquad { type: "squad"; } + + /** + * This is the target that will be run against the eval + */ + export type Response = Vapi.EvalRunTarget.Assistant | Vapi.EvalRunTarget.Squad; } diff --git a/src/api/types/EvalRunTargetAssistant.ts b/src/api/types/EvalRunTargetAssistant.ts index 3877dc76..049eb50a 100644 --- a/src/api/types/EvalRunTargetAssistant.ts +++ b/src/api/types/EvalRunTargetAssistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant overrides. + */ export interface EvalRunTargetAssistant { /** This is the transient assistant that will be run against the eval */ assistant?: Vapi.CreateAssistantDto | undefined; diff --git a/src/api/types/EvalRunTargetSquad.ts b/src/api/types/EvalRunTargetSquad.ts index 098d3748..ebcb852f 100644 --- a/src/api/types/EvalRunTargetSquad.ts +++ b/src/api/types/EvalRunTargetSquad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides. + */ export interface EvalRunTargetSquad { /** This is the transient squad that will be run against the eval */ squad?: Vapi.CreateSquadDto | undefined; diff --git a/src/api/types/EvaluationPlanItem.ts b/src/api/types/EvaluationPlanItem.ts index e1a17dd7..f8f60ea2 100644 --- a/src/api/types/EvaluationPlanItem.ts +++ b/src/api/types/EvaluationPlanItem.ts @@ -3,33 +3,16 @@ import type * as Vapi from "../index.js"; export interface EvaluationPlanItem { - /** - * This is the ID of an existing structured output to use for evaluation. - * Mutually exclusive with structuredOutput. - */ + /** The ID of an existing structured output to evaluate. Use this to reuse a structured output across scenarios. Provide either `structuredOutputId` or an inline `structuredOutput`. */ structuredOutputId?: string | undefined; - /** - * This is an inline structured output definition for evaluation. - * Mutually exclusive with structuredOutputId. - * Only primitive schema types (string, number, integer, boolean) are allowed. - */ + /** An inline structured output to evaluate, defined by its name and schema. Only primitive types (string, number, integer, boolean) are allowed. Provide either this or `structuredOutputId`. */ structuredOutput?: Vapi.CreateStructuredOutputDto | undefined; - /** - * This is the comparison operator to use when evaluating the extracted value against the expected value. - * Available operators depend on the structured output's schema type: - * - boolean: '=', '!=' - * - string: '=', '!=' - * - number/integer: '=', '!=', '>', '<', '>=', '<=' - */ + /** Optional dot-notation path to a primitive leaf when evaluating an object structured output. */ + path?: string | undefined; + /** How the structured output value is compared against `value`. Available operators depend on the output type. Boolean and string support `=` and `!=`; number and integer support `=`, `!=`, `>`, `<`, `>=`, `<=`. */ comparator: Vapi.EvaluationPlanItemComparator; - /** - * This is the expected value to compare against the extracted structured output result. - * Type should match the structured output's schema type. - */ + /** The expected value the structured output is compared against. Its type should match the structured output's type, for example `true` for a boolean. */ value: Vapi.EvaluationPlanItemValue; - /** - * This is whether this evaluation must pass for the simulation to pass. - * Defaults to true. If false, the result is informational only. - */ + /** Set to `false` to record this evaluation's result without requiring it to pass. Default is `true`. */ required?: boolean | undefined; } diff --git a/src/api/types/EvaluationPlanItemComparator.ts b/src/api/types/EvaluationPlanItemComparator.ts index 674066cb..59e94cab 100644 --- a/src/api/types/EvaluationPlanItemComparator.ts +++ b/src/api/types/EvaluationPlanItemComparator.ts @@ -1,12 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** - * This is the comparison operator to use when evaluating the extracted value against the expected value. - * Available operators depend on the structured output's schema type: - * - boolean: '=', '!=' - * - string: '=', '!=' - * - number/integer: '=', '!=', '>', '<', '>=', '<=' - */ +/** How the structured output value is compared against `value`. Available operators depend on the output type. Boolean and string support `=` and `!=`; number and integer support `=`, `!=`, `>`, `<`, `>=`, `<=`. */ export const EvaluationPlanItemComparator = { EqualTo: "=", NotEquals: "!=", diff --git a/src/api/types/EvaluationPlanItemValue.ts b/src/api/types/EvaluationPlanItemValue.ts index 891e3b73..7b8bb4f4 100644 --- a/src/api/types/EvaluationPlanItemValue.ts +++ b/src/api/types/EvaluationPlanItemValue.ts @@ -1,7 +1,6 @@ // This file was auto-generated by Fern from our API Definition. /** - * This is the expected value to compare against the extracted structured output result. - * Type should match the structured output's schema type. + * The expected value the structured output is compared against. Its type should match the structured output's type, for example `true` for a boolean. */ export type EvaluationPlanItemValue = number | string | boolean; diff --git a/src/api/types/EventsTableBooleanCondition.ts b/src/api/types/EventsTableBooleanCondition.ts index c6b9bce2..71e35286 100644 --- a/src/api/types/EventsTableBooleanCondition.ts +++ b/src/api/types/EventsTableBooleanCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing a boolean field with an expected value. + */ export interface EventsTableBooleanCondition { /** The boolean field name from the event data */ column: string; diff --git a/src/api/types/EventsTableNumberCondition.ts b/src/api/types/EventsTableNumberCondition.ts index 7b93fef3..5f54d738 100644 --- a/src/api/types/EventsTableNumberCondition.ts +++ b/src/api/types/EventsTableNumberCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing a numeric field with a value. + */ export interface EventsTableNumberCondition { /** The number field name from the event data */ column: string; diff --git a/src/api/types/EventsTableStringCondition.ts b/src/api/types/EventsTableStringCondition.ts index 870330cd..d65fd720 100644 --- a/src/api/types/EventsTableStringCondition.ts +++ b/src/api/types/EventsTableStringCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters event data by comparing or searching a string field. + */ export interface EventsTableStringCondition { /** The string field name from the event data */ column: string; diff --git a/src/api/types/ExactReplacement.ts b/src/api/types/ExactReplacement.ts index d1ad5e87..aec57620 100644 --- a/src/api/types/ExactReplacement.ts +++ b/src/api/types/ExactReplacement.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Replaces an exact word or phrase before text is sent to a voice provider. + */ export interface ExactReplacement { /** * This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance. diff --git a/src/api/types/ExportChatDto.ts b/src/api/types/ExportChatDto.ts index df56dded..a6a0d609 100644 --- a/src/api/types/ExportChatDto.ts +++ b/src/api/types/ExportChatDto.ts @@ -15,6 +15,8 @@ export interface ExportChatDto { sessionId?: string | undefined; /** This is the unique identifier for the previous chat to filter by. */ previousChatId?: string | undefined; + /** Filter by multiple chat IDs. Provide as comma-separated values. */ + idAny?: string | undefined; /** Columns to include in the CSV export */ columns?: Vapi.ExportChatDtoColumns | undefined; /** @@ -32,6 +34,8 @@ export interface ExportChatDto { page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ExportChatDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ExportChatDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/ExportChatDtoSortBy.ts b/src/api/types/ExportChatDtoSortBy.ts new file mode 100644 index 00000000..96e6936b --- /dev/null +++ b/src/api/types/ExportChatDtoSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const ExportChatDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ExportChatDtoSortBy = (typeof ExportChatDtoSortBy)[keyof typeof ExportChatDtoSortBy]; diff --git a/src/api/types/ExportSessionDto.ts b/src/api/types/ExportSessionDto.ts index 4f14a952..4adf1858 100644 --- a/src/api/types/ExportSessionDto.ts +++ b/src/api/types/ExportSessionDto.ts @@ -19,6 +19,8 @@ export interface ExportSessionDto { customer?: Vapi.CreateCustomerDto | undefined; /** Filter by any of the specified customer phone numbers (comma-separated). */ customerNumberAny?: string | undefined; + /** Filter by multiple session IDs. Provide as comma-separated values. */ + idAny?: string | undefined; /** Columns to include in the CSV export */ columns?: Vapi.ExportSessionDtoColumns | undefined; /** @@ -40,6 +42,8 @@ export interface ExportSessionDto { page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.ExportSessionDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.ExportSessionDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/ExportSessionDtoSortBy.ts b/src/api/types/ExportSessionDtoSortBy.ts new file mode 100644 index 00000000..facd08d5 --- /dev/null +++ b/src/api/types/ExportSessionDtoSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const ExportSessionDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type ExportSessionDtoSortBy = (typeof ExportSessionDtoSortBy)[keyof typeof ExportSessionDtoSortBy]; diff --git a/src/api/types/FallbackAssemblyAiTranscriber.ts b/src/api/types/FallbackAssemblyAiTranscriber.ts index 54825824..22317d49 100644 --- a/src/api/types/FallbackAssemblyAiTranscriber.ts +++ b/src/api/types/FallbackAssemblyAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, and vocabulary. + */ export interface FallbackAssemblyAiTranscriber { /** This is the language that will be set for the transcription. */ language?: Vapi.FallbackAssemblyAiTranscriberLanguage | undefined; @@ -47,9 +50,22 @@ export interface FallbackAssemblyAiTranscriber { * @default true */ vadAssistedEndpointingEnabled?: boolean | undefined; + /** + * This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model. + * + * @default 'balanced' + */ + mode?: Vapi.FallbackAssemblyAiTranscriberMode | undefined; + /** This is a prompt that provides additional context to the transcription model. Only applies to the `universal-3-5-pro` speech model. */ + prompt?: string | undefined; + /** This is context about the voice agent that guides the transcription model. Only applies to the `universal-3-5-pro` speech model. */ + agentContext?: string | undefined; + /** These are language codes used to steer automatic language detection. Only applies to the `universal-3-5-pro` speech model. */ + languageCodes?: Vapi.FallbackAssemblyAiTranscriberLanguageCodesItem[] | undefined; /** * This is the speech model used for the streaming session. - * Note: Keyterms prompting is not supported with multilingual streaming. + * Keyterms prompting is supported on universal-streaming-english and universal-3-5-pro. + * universal-3-5-pro is AssemblyAI's most accurate voice-agent model. * @default 'universal-streaming-english' */ speechModel?: Vapi.FallbackAssemblyAiTranscriberSpeechModel | undefined; @@ -60,7 +76,7 @@ export interface FallbackAssemblyAiTranscriber { /** * Keyterms prompting improves recognition accuracy for specific words and phrases. * Can include up to 100 keyterms, each up to 50 characters. - * Costs an additional $0.04/hour when enabled. + * Costs an additional $0.04/hour on universal-streaming-english and is included at no extra cost on universal-3-5-pro. */ keytermsPrompt?: string[] | undefined; /** The duration of the end utterance silence threshold in milliseconds. */ diff --git a/src/api/types/FallbackAssemblyAiTranscriberLanguageCodesItem.ts b/src/api/types/FallbackAssemblyAiTranscriberLanguageCodesItem.ts new file mode 100644 index 00000000..86b7dbac --- /dev/null +++ b/src/api/types/FallbackAssemblyAiTranscriberLanguageCodesItem.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +export const FallbackAssemblyAiTranscriberLanguageCodesItem = { + En: "en", + Es: "es", + Fr: "fr", + De: "de", + It: "it", + Pt: "pt", + Tr: "tr", + Nl: "nl", + Sv: "sv", + No: "no", + Da: "da", + Fi: "fi", + Hi: "hi", + Vi: "vi", + Ar: "ar", + He: "he", + Ja: "ja", + Zh: "zh", +} as const; +export type FallbackAssemblyAiTranscriberLanguageCodesItem = + (typeof FallbackAssemblyAiTranscriberLanguageCodesItem)[keyof typeof FallbackAssemblyAiTranscriberLanguageCodesItem]; diff --git a/src/api/types/FallbackAssemblyAiTranscriberMode.ts b/src/api/types/FallbackAssemblyAiTranscriberMode.ts new file mode 100644 index 00000000..b2793b04 --- /dev/null +++ b/src/api/types/FallbackAssemblyAiTranscriberMode.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the transcription mode used by the `universal-3-5-pro` speech model. Only applies to the `universal-3-5-pro` speech model. + * + * @default 'balanced' + */ +export const FallbackAssemblyAiTranscriberMode = { + MaxAccuracy: "max_accuracy", + MinLatency: "min_latency", + Balanced: "balanced", +} as const; +export type FallbackAssemblyAiTranscriberMode = + (typeof FallbackAssemblyAiTranscriberMode)[keyof typeof FallbackAssemblyAiTranscriberMode]; diff --git a/src/api/types/FallbackAssemblyAiTranscriberSpeechModel.ts b/src/api/types/FallbackAssemblyAiTranscriberSpeechModel.ts index a3daa476..83d847e4 100644 --- a/src/api/types/FallbackAssemblyAiTranscriberSpeechModel.ts +++ b/src/api/types/FallbackAssemblyAiTranscriberSpeechModel.ts @@ -2,12 +2,14 @@ /** * This is the speech model used for the streaming session. - * Note: Keyterms prompting is not supported with multilingual streaming. + * Keyterms prompting is supported on universal-streaming-english and universal-3-5-pro. + * universal-3-5-pro is AssemblyAI's most accurate voice-agent model. * @default 'universal-streaming-english' */ export const FallbackAssemblyAiTranscriberSpeechModel = { UniversalStreamingEnglish: "universal-streaming-english", UniversalStreamingMultilingual: "universal-streaming-multilingual", + Universal35Pro: "universal-3-5-pro", } as const; export type FallbackAssemblyAiTranscriberSpeechModel = (typeof FallbackAssemblyAiTranscriberSpeechModel)[keyof typeof FallbackAssemblyAiTranscriberSpeechModel]; diff --git a/src/api/types/FallbackAzureSpeechTranscriber.ts b/src/api/types/FallbackAzureSpeechTranscriber.ts index 16103bb9..96571dd7 100644 --- a/src/api/types/FallbackAzureSpeechTranscriber.ts +++ b/src/api/types/FallbackAzureSpeechTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Azure Speech, including language and segmentation. + */ export interface FallbackAzureSpeechTranscriber { /** This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt */ language?: Vapi.FallbackAzureSpeechTranscriberLanguage | undefined; diff --git a/src/api/types/FallbackAzureVoice.ts b/src/api/types/FallbackAzureVoice.ts index 796ae403..1e63ef27 100644 --- a/src/api/types/FallbackAzureVoice.ts +++ b/src/api/types/FallbackAzureVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, and caching. + */ export interface FallbackAzureVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackCartesiaTranscriber.ts b/src/api/types/FallbackCartesiaTranscriber.ts index 2ed07955..c86ed000 100644 --- a/src/api/types/FallbackCartesiaTranscriber.ts +++ b/src/api/types/FallbackCartesiaTranscriber.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Cartesia, including model and language. + */ export interface FallbackCartesiaTranscriber { + /** The Cartesia speech-to-text model used for transcription. */ model?: Vapi.FallbackCartesiaTranscriberModel | undefined; + /** The language code used for transcription. */ language?: Vapi.FallbackCartesiaTranscriberLanguage | undefined; } diff --git a/src/api/types/FallbackCartesiaTranscriberLanguage.ts b/src/api/types/FallbackCartesiaTranscriberLanguage.ts index 058e3259..cb2c1cb2 100644 --- a/src/api/types/FallbackCartesiaTranscriberLanguage.ts +++ b/src/api/types/FallbackCartesiaTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The language code used for transcription. */ export const FallbackCartesiaTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/FallbackCartesiaTranscriberModel.ts b/src/api/types/FallbackCartesiaTranscriberModel.ts index f6b08d86..da1d47e4 100644 --- a/src/api/types/FallbackCartesiaTranscriberModel.ts +++ b/src/api/types/FallbackCartesiaTranscriberModel.ts @@ -1,7 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +/** The Cartesia speech-to-text model used for transcription. */ export const FallbackCartesiaTranscriberModel = { InkWhisper: "ink-whisper", + Ink2: "ink-2", } as const; export type FallbackCartesiaTranscriberModel = (typeof FallbackCartesiaTranscriberModel)[keyof typeof FallbackCartesiaTranscriberModel]; diff --git a/src/api/types/FallbackCartesiaVoice.ts b/src/api/types/FallbackCartesiaVoice.ts index f54b9783..fb102192 100644 --- a/src/api/types/FallbackCartesiaVoice.ts +++ b/src/api/types/FallbackCartesiaVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, and caching. + */ export interface FallbackCartesiaVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackCartesiaVoiceModel.ts b/src/api/types/FallbackCartesiaVoiceModel.ts index 00fdf792..1d4c41cd 100644 --- a/src/api/types/FallbackCartesiaVoiceModel.ts +++ b/src/api/types/FallbackCartesiaVoiceModel.ts @@ -2,6 +2,8 @@ /** This is the model that will be used. This is optional and will default to the correct model for the voiceId. */ export const FallbackCartesiaVoiceModel = { + Sonic35: "sonic-3.5", + Sonic3520260504: "sonic-3.5-2026-05-04", Sonic3: "sonic-3", Sonic320260112: "sonic-3-2026-01-12", Sonic320251027: "sonic-3-2025-10-27", diff --git a/src/api/types/FallbackCustomTranscriber.ts b/src/api/types/FallbackCustomTranscriber.ts index 3273ca22..5a7b7e81 100644 --- a/src/api/types/FallbackCustomTranscriber.ts +++ b/src/api/types/FallbackCustomTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for sending conversation audio to a custom WebSocket transcription server. + */ export interface FallbackCustomTranscriber { /** * This is where the transcription request will be sent. diff --git a/src/api/types/FallbackCustomVoice.ts b/src/api/types/FallbackCustomVoice.ts index 3caa3e8f..27dc9512 100644 --- a/src/api/types/FallbackCustomVoice.ts +++ b/src/api/types/FallbackCustomVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, and caching. + */ export interface FallbackCustomVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackDeepgramTranscriber.ts b/src/api/types/FallbackDeepgramTranscriber.ts index 61b2d9c2..f7f03207 100644 --- a/src/api/types/FallbackDeepgramTranscriber.ts +++ b/src/api/types/FallbackDeepgramTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, and vocabulary. + */ export interface FallbackDeepgramTranscriber { /** This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview */ model?: Vapi.DeepgramTranscriberModel | undefined; @@ -29,14 +32,27 @@ export interface FallbackDeepgramTranscriber { * @default false */ profanityFilter?: boolean | undefined; + /** + * Enables redaction of sensitive information from transcripts. + * + * Options include: + * - "pci": Redacts credit card numbers, expiration dates, and CVV. + * - "pii": Redacts personally identifiable information (names, locations, identifying numbers, etc.). + * - "phi": Redacts protected health information (medical conditions, drugs, injuries, etc.). + * - "numbers": Redacts numerical and identifying entities (dates, account numbers, SSNs, etc.). + * + * Multiple values can be provided to redact different categories simultaneously. + * Redacted content is replaced with entity labels like [CREDIT_CARD_1], [SSN_1], etc. + * + * See https://developers.deepgram.com/docs/redaction for details. + */ + redaction?: Vapi.FallbackDeepgramTranscriberRedactionItem[] | undefined; /** * Transcripts below this confidence threshold will be discarded. * * @default 0.4 */ confidenceThreshold?: number | undefined; - /** Eager end-of-turn confidence required to fire a eager end-of-turn event. Setting a value here will enable EagerEndOfTurn and SpeechResumed events. It is disabled by default. Only used with Flux models. */ - eagerEotThreshold?: number | undefined; /** * End-of-turn confidence required to finish a turn. Only used with Flux models. * @@ -49,6 +65,12 @@ export interface FallbackDeepgramTranscriber { * @default 5000 */ eotTimeoutMs?: number | undefined; + /** + * Language hints to bias Flux Multilingual (`flux-general-multi`) toward specific languages. + * Provide BCP-47 language codes (e.g. "en", "es", "fr"). Multiple hints can be given for + * multilingual or code-switching scenarios. Omit for auto-detection. Only used with `flux-general-multi`. + */ + languages?: string[] | undefined; /** These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here. */ keywords?: string[] | undefined; /** Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%. */ diff --git a/src/api/types/FallbackDeepgramTranscriberRedactionItem.ts b/src/api/types/FallbackDeepgramTranscriberRedactionItem.ts new file mode 100644 index 00000000..1f6393f3 --- /dev/null +++ b/src/api/types/FallbackDeepgramTranscriberRedactionItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export const FallbackDeepgramTranscriberRedactionItem = { + Pci: "pci", + Pii: "pii", + Phi: "phi", + Numbers: "numbers", +} as const; +export type FallbackDeepgramTranscriberRedactionItem = + (typeof FallbackDeepgramTranscriberRedactionItem)[keyof typeof FallbackDeepgramTranscriberRedactionItem]; diff --git a/src/api/types/FallbackDeepgramVoice.ts b/src/api/types/FallbackDeepgramVoice.ts index a20d91f9..63c9b903 100644 --- a/src/api/types/FallbackDeepgramVoice.ts +++ b/src/api/types/FallbackDeepgramVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, and caching. + */ export interface FallbackDeepgramVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackDeepgramVoiceId.ts b/src/api/types/FallbackDeepgramVoiceId.ts index a58635cd..a15e71c3 100644 --- a/src/api/types/FallbackDeepgramVoiceId.ts +++ b/src/api/types/FallbackDeepgramVoiceId.ts @@ -57,5 +57,12 @@ export const FallbackDeepgramVoiceId = { Aquila: "aquila", Selena: "selena", Javier: "javier", + Viktoria: "viktoria", + Kara: "kara", + Fabian: "fabian", + Julius: "julius", + Lara: "lara", + Elara: "elara", + Aurelia: "aurelia", } as const; export type FallbackDeepgramVoiceId = (typeof FallbackDeepgramVoiceId)[keyof typeof FallbackDeepgramVoiceId]; diff --git a/src/api/types/FallbackElevenLabsTranscriber.ts b/src/api/types/FallbackElevenLabsTranscriber.ts index a3244172..e2a33efd 100644 --- a/src/api/types/FallbackElevenLabsTranscriber.ts +++ b/src/api/types/FallbackElevenLabsTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds. + */ export interface FallbackElevenLabsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackElevenLabsTranscriberModel | undefined; diff --git a/src/api/types/FallbackElevenLabsVoice.ts b/src/api/types/FallbackElevenLabsVoice.ts index ea106d21..b6a93bbd 100644 --- a/src/api/types/FallbackElevenLabsVoice.ts +++ b/src/api/types/FallbackElevenLabsVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, and caching. + */ export interface FallbackElevenLabsVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackGladiaTranscriber.ts b/src/api/types/FallbackGladiaTranscriber.ts index 036cc335..c271d633 100644 --- a/src/api/types/FallbackGladiaTranscriber.ts +++ b/src/api/types/FallbackGladiaTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, endpointing, vocabulary, and region. + */ export interface FallbackGladiaTranscriber { /** This is the Gladia model that will be used. Default is 'fast' */ model?: Vapi.FallbackGladiaTranscriberModel | undefined; @@ -10,7 +13,7 @@ export interface FallbackGladiaTranscriber { /** Defines the language to use for the transcription. Required when languageBehaviour is 'manual'. */ language?: Vapi.FallbackGladiaTranscriberLanguage | undefined; /** Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'. */ - languages?: Vapi.FallbackGladiaTranscriberLanguages | undefined; + languages?: Vapi.FallbackGladiaTranscriberLanguagesItem[] | undefined; /** * Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored. * ⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit. diff --git a/src/api/types/GladiaTranscriberLanguages.ts b/src/api/types/FallbackGladiaTranscriberLanguagesItem.ts similarity index 84% rename from src/api/types/GladiaTranscriberLanguages.ts rename to src/api/types/FallbackGladiaTranscriberLanguagesItem.ts index 25d3b679..6ed5a15c 100644 --- a/src/api/types/GladiaTranscriberLanguages.ts +++ b/src/api/types/FallbackGladiaTranscriberLanguagesItem.ts @@ -1,7 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'. */ -export const GladiaTranscriberLanguages = { +export const FallbackGladiaTranscriberLanguagesItem = { Af: "af", Sq: "sq", Am: "am", @@ -102,4 +101,5 @@ export const GladiaTranscriberLanguages = { Yi: "yi", Yo: "yo", } as const; -export type GladiaTranscriberLanguages = (typeof GladiaTranscriberLanguages)[keyof typeof GladiaTranscriberLanguages]; +export type FallbackGladiaTranscriberLanguagesItem = + (typeof FallbackGladiaTranscriberLanguagesItem)[keyof typeof FallbackGladiaTranscriberLanguagesItem]; diff --git a/src/api/types/FallbackGoogleTranscriber.ts b/src/api/types/FallbackGoogleTranscriber.ts index 89a2cb67..30b3102d 100644 --- a/src/api/types/FallbackGoogleTranscriber.ts +++ b/src/api/types/FallbackGoogleTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Google, including model and language. + */ export interface FallbackGoogleTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackGoogleTranscriberModel | undefined; diff --git a/src/api/types/FallbackGoogleTranscriberModel.ts b/src/api/types/FallbackGoogleTranscriberModel.ts index 05413ed2..7be82a72 100644 --- a/src/api/types/FallbackGoogleTranscriberModel.ts +++ b/src/api/types/FallbackGoogleTranscriberModel.ts @@ -2,6 +2,8 @@ /** This is the model that will be used for the transcription. */ export const FallbackGoogleTranscriberModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/FallbackHumeVoice.ts b/src/api/types/FallbackHumeVoice.ts index 155db82c..bc20d6cb 100644 --- a/src/api/types/FallbackHumeVoice.ts +++ b/src/api/types/FallbackHumeVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, and caching. + */ export interface FallbackHumeVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackInworldVoice.ts b/src/api/types/FallbackInworldVoice.ts index 7ff3fefc..98f86a30 100644 --- a/src/api/types/FallbackInworldVoice.ts +++ b/src/api/types/FallbackInworldVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, and caching. + */ export interface FallbackInworldVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackLmntVoice.ts b/src/api/types/FallbackLmntVoice.ts index 08bb6e26..f98123d4 100644 --- a/src/api/types/FallbackLmntVoice.ts +++ b/src/api/types/FallbackLmntVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, and caching. + */ export interface FallbackLmntVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackMicrosoftVoice.ts b/src/api/types/FallbackMicrosoftVoice.ts new file mode 100644 index 00000000..111fdca7 --- /dev/null +++ b/src/api/types/FallbackMicrosoftVoice.ts @@ -0,0 +1,20 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface FallbackMicrosoftVoice { + /** This is the flag to toggle voice caching for the assistant. */ + cachingEnabled?: boolean | undefined; + /** MAI-Voice-2 voice ID. Built-in voices listed in enum. */ + voiceId: Vapi.FallbackMicrosoftVoiceVoiceId; + /** Speaking style applied via mstts:express-as on every request. Unknown styles are ignored by Azure and fall back to neutral. */ + style?: Vapi.FallbackMicrosoftVoiceStyle | undefined; + /** Style intensity (0.01–2). Default 1 = the predefined style strength. Only applies when `style` is set. */ + styleDegree?: number | undefined; + /** Role-play (age/gender imitation). Requires `style` to be set; ignored otherwise. */ + role?: Vapi.FallbackMicrosoftVoiceRole | undefined; + /** This is the speed multiplier that will be used. */ + speed?: number | undefined; + /** This is the plan for chunking the model output before it is sent to the voice provider. */ + chunkPlan?: Vapi.ChunkPlan | undefined; +} diff --git a/src/api/types/FallbackMicrosoftVoiceRole.ts b/src/api/types/FallbackMicrosoftVoiceRole.ts new file mode 100644 index 00000000..c4b75dfc --- /dev/null +++ b/src/api/types/FallbackMicrosoftVoiceRole.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Role-play (age/gender imitation). Requires `style` to be set; ignored otherwise. */ +export const FallbackMicrosoftVoiceRole = { + Girl: "Girl", + Boy: "Boy", + YoungAdultFemale: "YoungAdultFemale", + YoungAdultMale: "YoungAdultMale", + OlderAdultFemale: "OlderAdultFemale", + OlderAdultMale: "OlderAdultMale", + SeniorFemale: "SeniorFemale", + SeniorMale: "SeniorMale", +} as const; +export type FallbackMicrosoftVoiceRole = (typeof FallbackMicrosoftVoiceRole)[keyof typeof FallbackMicrosoftVoiceRole]; diff --git a/src/api/types/FallbackMicrosoftVoiceStyle.ts b/src/api/types/FallbackMicrosoftVoiceStyle.ts new file mode 100644 index 00000000..d83f9f49 --- /dev/null +++ b/src/api/types/FallbackMicrosoftVoiceStyle.ts @@ -0,0 +1,36 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Speaking style applied via mstts:express-as on every request. Unknown styles are ignored by Azure and fall back to neutral. */ +export const FallbackMicrosoftVoiceStyle = { + Adventurous: "adventurous", + Angry: "angry", + Caring: "caring", + Cheerful: "cheerful", + Confused: "confused", + Curious: "curious", + Determined: "determined", + Disappointed: "disappointed", + Disgusted: "disgusted", + Embarrassed: "embarrassed", + Empathy: "empathy", + Encouraging: "encouraging", + Excited: "excited", + Fearful: "fearful", + Friendly: "friendly", + Happy: "happy", + Hopeful: "hopeful", + Jealous: "jealous", + Joyful: "joyful", + Nostalgic: "nostalgic", + Reflective: "reflective", + Regretful: "regretful", + Relieved: "relieved", + Sad: "sad", + Serious: "serious", + Shouting: "shouting", + Softvoice: "softvoice", + Surprised: "surprised", + Whispering: "whispering", +} as const; +export type FallbackMicrosoftVoiceStyle = + (typeof FallbackMicrosoftVoiceStyle)[keyof typeof FallbackMicrosoftVoiceStyle]; diff --git a/src/api/types/FallbackMicrosoftVoiceVoiceId.ts b/src/api/types/FallbackMicrosoftVoiceVoiceId.ts new file mode 100644 index 00000000..ed9816b9 --- /dev/null +++ b/src/api/types/FallbackMicrosoftVoiceVoiceId.ts @@ -0,0 +1,53 @@ +// This file was auto-generated by Fern from our API Definition. + +/** MAI-Voice-2 voice ID. Built-in voices listed in enum. */ +export const FallbackMicrosoftVoiceVoiceId = { + DeDeKlausMaiVoice2: "de-DE-Klaus:MAI-Voice-2", + DeDeMiaMaiVoice2: "de-DE-Mia:MAI-Voice-2", + EnAuLisaMaiVoice2: "en-AU-Lisa:MAI-Voice-2", + EnUsEthanMaiVoice2: "en-US-Ethan:MAI-Voice-2", + EnUsGrantMaiVoice2: "en-US-Grant:MAI-Voice-2", + EnUsHarperMaiVoice2: "en-US-Harper:MAI-Voice-2", + EnUsIrisMaiVoice2: "en-US-Iris:MAI-Voice-2", + EnUsJasperMaiVoice2: "en-US-Jasper:MAI-Voice-2", + EnUsOliviaMaiVoice2: "en-US-Olivia:MAI-Voice-2", + EsEsMartaMaiVoice2: "es-ES-Marta:MAI-Voice-2", + EsMxAlejoMaiVoice2: "es-MX-Alejo:MAI-Voice-2", + EsMxValeriaMaiVoice2: "es-MX-Valeria:MAI-Voice-2", + FrFrMarcMaiVoice2: "fr-FR-Marc:MAI-Voice-2", + FrFrSoleilMaiVoice2: "fr-FR-Soleil:MAI-Voice-2", + HiInArjunMaiVoice2: "hi-IN-Arjun:MAI-Voice-2", + HiInDhruvMaiVoice2: "hi-IN-Dhruv:MAI-Voice-2", + HiInKavyaMaiVoice2: "hi-IN-Kavya:MAI-Voice-2", + HiInPriyaMaiVoice2: "hi-IN-Priya:MAI-Voice-2", + HuHuBenceMaiVoice2: "hu-HU-Bence:MAI-Voice-2", + HuHuLeventeMaiVoice2: "hu-HU-Levente:MAI-Voice-2", + HuHuLillaMaiVoice2: "hu-HU-Lilla:MAI-Voice-2", + HuHuRekaMaiVoice2: "hu-HU-R\u00E9ka:MAI-Voice-2", + ItItLucaMaiVoice2: "it-IT-Luca:MAI-Voice-2", + ItItRosaMaiVoice2: "it-IT-Rosa:MAI-Voice-2", + KoKrHanaMaiVoice2: "ko-KR-Hana:MAI-Voice-2", + KoKrJunhoMaiVoice2: "ko-KR-Junho:MAI-Voice-2", + NlNlFleurMaiVoice2: "nl-NL-Fleur:MAI-Voice-2", + NlNlSanderMaiVoice2: "nl-NL-Sander:MAI-Voice-2", + PtBrCaioMaiVoice2: "pt-BR-Caio:MAI-Voice-2", + PtBrLuanaMaiVoice2: "pt-BR-Luana:MAI-Voice-2", + PtBrPedroMaiVoice2: "pt-BR-Pedro:MAI-Voice-2", + PtBrRafaelMaiVoice2: "pt-BR-Rafael:MAI-Voice-2", + PtPtRuiMaiVoice2: "pt-PT-Rui:MAI-Voice-2", + RoRoAndreiMaiVoice2: "ro-RO-Andrei:MAI-Voice-2", + RoRoElenaMaiVoice2: "ro-RO-Elena:MAI-Voice-2", + RoRoIoanaMaiVoice2: "ro-RO-Ioana:MAI-Voice-2", + RoRoRaduMaiVoice2: "ro-RO-Radu:MAI-Voice-2", + RuRuLevMaiVoice2: "ru-RU-Lev:MAI-Voice-2", + RuRuMashaMaiVoice2: "ru-RU-Masha:MAI-Voice-2", + ThThKritMaiVoice2: "th-TH-Krit:MAI-Voice-2", + ThThNattapongMaiVoice2: "th-TH-Nattapong:MAI-Voice-2", + TrTrAydinMaiVoice2: "tr-TR-Aydin:MAI-Voice-2", + TrTrElifMaiVoice2: "tr-TR-Elif:MAI-Voice-2", + ZhCnBoMaiVoice2: "zh-CN-Bo:MAI-Voice-2", + ZhCnLanMaiVoice2: "zh-CN-Lan:MAI-Voice-2", + ZhCnMeiMaiVoice2: "zh-CN-Mei:MAI-Voice-2", +} as const; +export type FallbackMicrosoftVoiceVoiceId = + (typeof FallbackMicrosoftVoiceVoiceId)[keyof typeof FallbackMicrosoftVoiceVoiceId]; diff --git a/src/api/types/FallbackNeuphonicVoice.ts b/src/api/types/FallbackNeuphonicVoice.ts index ef6ad94f..20017da8 100644 --- a/src/api/types/FallbackNeuphonicVoice.ts +++ b/src/api/types/FallbackNeuphonicVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, and caching. + */ export interface FallbackNeuphonicVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackOpenAiTranscriber.ts b/src/api/types/FallbackOpenAiTranscriber.ts index 2c791109..26030986 100644 --- a/src/api/types/FallbackOpenAiTranscriber.ts +++ b/src/api/types/FallbackOpenAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with OpenAI, including model and language. + */ export interface FallbackOpenAiTranscriber { /** This is the model that will be used for the transcription. */ model: Vapi.FallbackOpenAiTranscriberModel; diff --git a/src/api/types/FallbackOpenAiVoice.ts b/src/api/types/FallbackOpenAiVoice.ts index 3a582107..c826f01d 100644 --- a/src/api/types/FallbackOpenAiVoice.ts +++ b/src/api/types/FallbackOpenAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, and caching. + */ export interface FallbackOpenAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackPlan.ts b/src/api/types/FallbackPlan.ts index 0797b4a0..cc266826 100644 --- a/src/api/types/FallbackPlan.ts +++ b/src/api/types/FallbackPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Lists backup voice configurations that can be used if the primary voice provider fails. + */ export interface FallbackPlan { /** This is the list of voices to fallback to in the event that the primary voice provider fails. */ voices: Vapi.FallbackPlanVoicesItem[]; diff --git a/src/api/types/FallbackPlanVoicesItem.ts b/src/api/types/FallbackPlanVoicesItem.ts index e362b995..9e202484 100644 --- a/src/api/types/FallbackPlanVoicesItem.ts +++ b/src/api/types/FallbackPlanVoicesItem.ts @@ -19,7 +19,9 @@ export type FallbackPlanVoicesItem = | Vapi.FallbackPlanVoicesItem.Tavus | Vapi.FallbackPlanVoicesItem.Neuphonic | Vapi.FallbackPlanVoicesItem.Sesame - | Vapi.FallbackPlanVoicesItem.Inworld; + | Vapi.FallbackPlanVoicesItem.Inworld + | Vapi.FallbackPlanVoicesItem.Xai + | Vapi.FallbackPlanVoicesItem.Microsoft; export namespace FallbackPlanVoicesItem { export interface Azure extends Vapi.FallbackAzureVoice { @@ -89,4 +91,12 @@ export namespace FallbackPlanVoicesItem { export interface Inworld extends Vapi.FallbackInworldVoice { provider: "inworld"; } + + export interface Xai extends Vapi.FallbackXaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.FallbackMicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/FallbackPlayHtVoice.ts b/src/api/types/FallbackPlayHtVoice.ts index 83053ac3..24942ea7 100644 --- a/src/api/types/FallbackPlayHtVoice.ts +++ b/src/api/types/FallbackPlayHtVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, and caching. + */ export interface FallbackPlayHtVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackRimeAiVoice.ts b/src/api/types/FallbackRimeAiVoice.ts index 6ac1567c..8451b1f4 100644 --- a/src/api/types/FallbackRimeAiVoice.ts +++ b/src/api/types/FallbackRimeAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, and caching. + */ export interface FallbackRimeAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSesameVoice.ts b/src/api/types/FallbackSesameVoice.ts index 7e816a76..062878f1 100644 --- a/src/api/types/FallbackSesameVoice.ts +++ b/src/api/types/FallbackSesameVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, and caching. + */ export interface FallbackSesameVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSmallestAiVoice.ts b/src/api/types/FallbackSmallestAiVoice.ts index e7c4563c..dc6475f8 100644 --- a/src/api/types/FallbackSmallestAiVoice.ts +++ b/src/api/types/FallbackSmallestAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, and caching. + */ export interface FallbackSmallestAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackSonioxTranscriber.ts b/src/api/types/FallbackSonioxTranscriber.ts index 6faab381..05881dd6 100644 --- a/src/api/types/FallbackSonioxTranscriber.ts +++ b/src/api/types/FallbackSonioxTranscriber.ts @@ -2,15 +2,22 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and vocabulary. + */ export interface FallbackSonioxTranscriber { /** The Soniox model to use for transcription. */ model?: Vapi.FallbackSonioxTranscriberModel | undefined; - /** The language for transcription. Uses ISO 639-1 codes. Soniox supports 60+ languages with a single universal model. */ + /** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). For multi-language hints or to enable Soniox auto-detect, use `languages` instead — when `languages` is set (including to an empty array), this field is ignored when building the Soniox request. Defaults to `en` if neither this nor `languages` is set. */ language?: Vapi.FallbackSonioxTranscriberLanguage | undefined; - /** When enabled, restricts transcription to the language specified in the language field. When disabled, the model can detect and transcribe any of 60+ supported languages. Defaults to true. */ + /** Language hints sent to Soniox as `language_hints`. Provide `[lang1, lang2, ...]` (ISO 639-1 codes) to bias recognition toward specific languages, or provide an explicit empty array `[]` to enable Soniox auto-detect across all 60+ supported languages. When set (including the empty array), this field takes precedence over the singular `language` field. When omitted, falls back to the singular `language` (which defaults to `en` if also unset). Best accuracy is achieved with a single language. */ + languages?: Vapi.FallbackSonioxTranscriberLanguagesItem[] | undefined; + /** When `true`, Soniox strictly restricts transcription to the languages in `languages` (or the singular `language` if `languages` is unset). When `false`, Soniox biases toward those languages but still allows transcription in other languages. Has no effect when no language hints are sent (e.g., `languages: []` for auto-detect). Defaults to `true` (strict mode). */ languageHintsStrict?: boolean | undefined; /** Maximum delay in milliseconds between when the speaker stops and when the endpoint is detected. Lower values mean faster turn-taking but more false endpoints. Range: 500-3000. Default: 500. */ maxEndpointDelayMs?: number | undefined; /** Custom vocabulary terms to boost recognition accuracy. Useful for brand names, product names, and domain-specific terminology. Maps to Soniox context.terms. */ customVocabulary?: string[] | undefined; + /** General context key-value pairs that guide the AI model during transcription. Helps adapt vocabulary to the correct domain, improving accuracy. Recommended: 10 or fewer pairs. Maps to Soniox context.general. */ + contextGeneral?: Vapi.SonioxContextGeneralItem[] | undefined; } diff --git a/src/api/types/FallbackSonioxTranscriberLanguage.ts b/src/api/types/FallbackSonioxTranscriberLanguage.ts index 817c8313..27d6b4e6 100644 --- a/src/api/types/FallbackSonioxTranscriberLanguage.ts +++ b/src/api/types/FallbackSonioxTranscriberLanguage.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** The language for transcription. Uses ISO 639-1 codes. Soniox supports 60+ languages with a single universal model. */ +/** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). For multi-language hints or to enable Soniox auto-detect, use `languages` instead — when `languages` is set (including to an empty array), this field is ignored when building the Soniox request. Defaults to `en` if neither this nor `languages` is set. */ export const FallbackSonioxTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/FallbackSonioxTranscriberLanguagesItem.ts b/src/api/types/FallbackSonioxTranscriberLanguagesItem.ts new file mode 100644 index 00000000..8ed0397c --- /dev/null +++ b/src/api/types/FallbackSonioxTranscriberLanguagesItem.ts @@ -0,0 +1,191 @@ +// This file was auto-generated by Fern from our API Definition. + +export const FallbackSonioxTranscriberLanguagesItem = { + Aa: "aa", + Ab: "ab", + Ae: "ae", + Af: "af", + Ak: "ak", + Am: "am", + An: "an", + Ar: "ar", + As: "as", + Av: "av", + Ay: "ay", + Az: "az", + Ba: "ba", + Be: "be", + Bg: "bg", + Bh: "bh", + Bi: "bi", + Bm: "bm", + Bn: "bn", + Bo: "bo", + Br: "br", + Bs: "bs", + Ca: "ca", + Ce: "ce", + Ch: "ch", + Co: "co", + Cr: "cr", + Cs: "cs", + Cu: "cu", + Cv: "cv", + Cy: "cy", + Da: "da", + De: "de", + Dv: "dv", + Dz: "dz", + Ee: "ee", + El: "el", + En: "en", + Eo: "eo", + Es: "es", + Et: "et", + Eu: "eu", + Fa: "fa", + Ff: "ff", + Fi: "fi", + Fj: "fj", + Fo: "fo", + Fr: "fr", + Fy: "fy", + Ga: "ga", + Gd: "gd", + Gl: "gl", + Gn: "gn", + Gu: "gu", + Gv: "gv", + Ha: "ha", + He: "he", + Hi: "hi", + Ho: "ho", + Hr: "hr", + Ht: "ht", + Hu: "hu", + Hy: "hy", + Hz: "hz", + Ia: "ia", + Id: "id", + Ie: "ie", + Ig: "ig", + Ii: "ii", + Ik: "ik", + Io: "io", + Is: "is", + It: "it", + Iu: "iu", + Ja: "ja", + Jv: "jv", + Ka: "ka", + Kg: "kg", + Ki: "ki", + Kj: "kj", + Kk: "kk", + Kl: "kl", + Km: "km", + Kn: "kn", + Ko: "ko", + Kr: "kr", + Ks: "ks", + Ku: "ku", + Kv: "kv", + Kw: "kw", + Ky: "ky", + La: "la", + Lb: "lb", + Lg: "lg", + Li: "li", + Ln: "ln", + Lo: "lo", + Lt: "lt", + Lu: "lu", + Lv: "lv", + Mg: "mg", + Mh: "mh", + Mi: "mi", + Mk: "mk", + Ml: "ml", + Mn: "mn", + Mr: "mr", + Ms: "ms", + Mt: "mt", + My: "my", + Na: "na", + Nb: "nb", + Nd: "nd", + Ne: "ne", + Ng: "ng", + Nl: "nl", + Nn: "nn", + No: "no", + Nr: "nr", + Nv: "nv", + Ny: "ny", + Oc: "oc", + Oj: "oj", + Om: "om", + Or: "or", + Os: "os", + Pa: "pa", + Pi: "pi", + Pl: "pl", + Ps: "ps", + Pt: "pt", + Qu: "qu", + Rm: "rm", + Rn: "rn", + Ro: "ro", + Ru: "ru", + Rw: "rw", + Sa: "sa", + Sc: "sc", + Sd: "sd", + Se: "se", + Sg: "sg", + Si: "si", + Sk: "sk", + Sl: "sl", + Sm: "sm", + Sn: "sn", + So: "so", + Sq: "sq", + Sr: "sr", + Ss: "ss", + St: "st", + Su: "su", + Sv: "sv", + Sw: "sw", + Ta: "ta", + Te: "te", + Tg: "tg", + Th: "th", + Ti: "ti", + Tk: "tk", + Tl: "tl", + Tn: "tn", + To: "to", + Tr: "tr", + Ts: "ts", + Tt: "tt", + Tw: "tw", + Ty: "ty", + Ug: "ug", + Uk: "uk", + Ur: "ur", + Uz: "uz", + Ve: "ve", + Vi: "vi", + Vo: "vo", + Wa: "wa", + Wo: "wo", + Xh: "xh", + Yi: "yi", + Yue: "yue", + Yo: "yo", + Za: "za", + Zh: "zh", + Zu: "zu", +} as const; +export type FallbackSonioxTranscriberLanguagesItem = + (typeof FallbackSonioxTranscriberLanguagesItem)[keyof typeof FallbackSonioxTranscriberLanguagesItem]; diff --git a/src/api/types/FallbackSonioxTranscriberModel.ts b/src/api/types/FallbackSonioxTranscriberModel.ts index 9bef8ac1..cbf1cf4d 100644 --- a/src/api/types/FallbackSonioxTranscriberModel.ts +++ b/src/api/types/FallbackSonioxTranscriberModel.ts @@ -3,6 +3,7 @@ /** The Soniox model to use for transcription. */ export const FallbackSonioxTranscriberModel = { SttRtV4: "stt-rt-v4", + SttRtV5: "stt-rt-v5", } as const; export type FallbackSonioxTranscriberModel = (typeof FallbackSonioxTranscriberModel)[keyof typeof FallbackSonioxTranscriberModel]; diff --git a/src/api/types/FallbackSpeechmaticsTranscriber.ts b/src/api/types/FallbackSpeechmaticsTranscriber.ts index 31a7c0f3..f161e45f 100644 --- a/src/api/types/FallbackSpeechmaticsTranscriber.ts +++ b/src/api/types/FallbackSpeechmaticsTranscriber.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, vocabulary, endpointing, and formatting. + */ export interface FallbackSpeechmaticsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackSpeechmaticsTranscriberModel | undefined; + /** Language used for transcription. Set to `auto` to detect the language automatically. */ language?: Vapi.FallbackSpeechmaticsTranscriberLanguage | undefined; /** * This is the operating point for the transcription. Choose between `standard` for faster turnaround with strong accuracy or `enhanced` for highest accuracy when precision is critical. @@ -30,6 +34,7 @@ export interface FallbackSpeechmaticsTranscriber { * @default 3000 */ maxDelay?: number | undefined; + /** Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ customVocabulary: Vapi.SpeechmaticsCustomVocabularyItem[]; /** * This controls how numbers, dates, currencies, and other entities are formatted in the transcription output. diff --git a/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts b/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts index 4f8d9326..f84d3d71 100644 --- a/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts +++ b/src/api/types/FallbackSpeechmaticsTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language used for transcription. Set to `auto` to detect the language automatically. */ export const FallbackSpeechmaticsTranscriberLanguage = { Auto: "auto", Ar: "ar", diff --git a/src/api/types/FallbackTalkscriberTranscriber.ts b/src/api/types/FallbackTalkscriberTranscriber.ts index e4a1e287..04c19812 100644 --- a/src/api/types/FallbackTalkscriberTranscriber.ts +++ b/src/api/types/FallbackTalkscriberTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for transcribing speech with Talkscriber, including model and language. + */ export interface FallbackTalkscriberTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.FallbackTalkscriberTranscriberModel | undefined; diff --git a/src/api/types/FallbackTavusVoice.ts b/src/api/types/FallbackTavusVoice.ts index 7791ae86..ef67f9d5 100644 --- a/src/api/types/FallbackTavusVoice.ts +++ b/src/api/types/FallbackTavusVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, and caching. + */ export interface FallbackTavusVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackTranscriberPlan.ts b/src/api/types/FallbackTranscriberPlan.ts index 3eeeff5a..6fbeafeb 100644 --- a/src/api/types/FallbackTranscriberPlan.ts +++ b/src/api/types/FallbackTranscriberPlan.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Lists backup transcriber configurations that can be used if the primary transcriber fails. + */ export interface FallbackTranscriberPlan { - transcribers: Vapi.FallbackTranscriberPlanTranscribersItem[]; + /** Transcriber configurations available when the primary transcriber fails. */ + transcribers?: Vapi.FallbackTranscriberPlanTranscribersItem[] | undefined; } diff --git a/src/api/types/FallbackTranscriberPlanTranscribersItem.ts b/src/api/types/FallbackTranscriberPlanTranscribersItem.ts index aaa2d47d..4b333ae7 100644 --- a/src/api/types/FallbackTranscriberPlanTranscribersItem.ts +++ b/src/api/types/FallbackTranscriberPlanTranscribersItem.ts @@ -14,7 +14,8 @@ export type FallbackTranscriberPlanTranscribersItem = | Vapi.FallbackTranscriberPlanTranscribersItem.Speechmatics | Vapi.FallbackTranscriberPlanTranscribersItem.Openai | Vapi.FallbackTranscriberPlanTranscribersItem.Cartesia - | Vapi.FallbackTranscriberPlanTranscribersItem.Soniox; + | Vapi.FallbackTranscriberPlanTranscribersItem.Soniox + | Vapi.FallbackTranscriberPlanTranscribersItem.Xai; export namespace FallbackTranscriberPlanTranscribersItem { export interface AssemblyAi extends Vapi.FallbackAssemblyAiTranscriber { @@ -64,4 +65,8 @@ export namespace FallbackTranscriberPlanTranscribersItem { export interface Soniox extends Vapi.FallbackSonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.FallbackXaiTranscriber { + provider: "xai"; + } } diff --git a/src/api/types/FallbackVapiVoice.ts b/src/api/types/FallbackVapiVoice.ts index 59392438..913cde59 100644 --- a/src/api/types/FallbackVapiVoice.ts +++ b/src/api/types/FallbackVapiVoice.ts @@ -2,17 +2,24 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, and caching. + */ export interface FallbackVapiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; - /** The voices provided by Vapi */ - voiceId: Vapi.FallbackVapiVoiceVoiceId; + /** The voice to use: a built-in Vapi voice name, or a cloned voice id (used with version 2). */ + voiceId: string; + /** The Vapi voice routing generation. `latest` auto-updates to the newest generation; version 1 uses legacy mappings; version 2 can use xAI-backed voices when available. When omitted, Version 1 is used. Accepts the string channel ('latest', '1', '2'); legacy numeric values (1, 2) are also accepted and coerced to their string form. */ + version?: Vapi.FallbackVapiVoiceVersion | undefined; /** * This is the speed multiplier that will be used. * * @default 1 */ speed?: number | undefined; + /** Language for Vapi voice synthesis. For Version 2, omit this field or set `auto` for automatic language detection. Version 1 supports legacy Vapi language values. */ + language?: Vapi.FallbackVapiVoiceLanguage | undefined; /** List of pronunciation dictionary locators for custom word pronunciations. */ pronunciationDictionary?: Vapi.VapiPronunciationDictionaryLocator[] | undefined; /** This is the plan for chunking the model output before it is sent to the voice provider. */ diff --git a/src/api/types/FallbackVapiVoiceLanguage.ts b/src/api/types/FallbackVapiVoiceLanguage.ts new file mode 100644 index 00000000..1bdb540a --- /dev/null +++ b/src/api/types/FallbackVapiVoiceLanguage.ts @@ -0,0 +1,63 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Language for Vapi voice synthesis. For Version 2, omit this field or set `auto` for automatic language detection. Version 1 supports legacy Vapi language values. */ +export const FallbackVapiVoiceLanguage = { + EnUs: "en-US", + EnGb: "en-GB", + EnAu: "en-AU", + EnCa: "en-CA", + Ja: "ja", + Zh: "zh", + De: "de", + Hi: "hi", + FrFr: "fr-FR", + FrCa: "fr-CA", + Ko: "ko", + PtBr: "pt-BR", + PtPt: "pt-PT", + It: "it", + EsEs: "es-ES", + EsMx: "es-MX", + Id: "id", + Nl: "nl", + Tr: "tr", + Fil: "fil", + Pl: "pl", + Sv: "sv", + Bg: "bg", + Ro: "ro", + ArSa: "ar-SA", + ArAe: "ar-AE", + Cs: "cs", + El: "el", + Fi: "fi", + Hr: "hr", + Ms: "ms", + Sk: "sk", + Da: "da", + Ta: "ta", + Uk: "uk", + Ru: "ru", + Hu: "hu", + No: "no", + Vi: "vi", + Auto: "auto", + En: "en", + Ar: "ar", + ArEg: "ar-EG", + Bn: "bn", + Es: "es", + Fr: "fr", + Gu: "gu", + He: "he", + Ka: "ka", + Kn: "kn", + Ml: "ml", + Mr: "mr", + Pa: "pa", + Pt: "pt", + Te: "te", + Th: "th", + Tl: "tl", +} as const; +export type FallbackVapiVoiceLanguage = (typeof FallbackVapiVoiceLanguage)[keyof typeof FallbackVapiVoiceLanguage]; diff --git a/src/api/types/FallbackVapiVoiceVersion.ts b/src/api/types/FallbackVapiVoiceVersion.ts new file mode 100644 index 00000000..55b7d94e --- /dev/null +++ b/src/api/types/FallbackVapiVoiceVersion.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The Vapi voice routing generation. `latest` auto-updates to the newest generation; version 1 uses legacy mappings; version 2 can use xAI-backed voices when available. When omitted, Version 1 is used. Accepts the string channel ('latest', '1', '2'); legacy numeric values (1, 2) are also accepted and coerced to their string form. */ +export const FallbackVapiVoiceVersion = { + One: "1", + Two: "2", + Latest: "latest", +} as const; +export type FallbackVapiVoiceVersion = (typeof FallbackVapiVoiceVersion)[keyof typeof FallbackVapiVoiceVersion]; diff --git a/src/api/types/FallbackVapiVoiceVoiceId.ts b/src/api/types/FallbackVapiVoiceVoiceId.ts deleted file mode 100644 index a9d16747..00000000 --- a/src/api/types/FallbackVapiVoiceVoiceId.ts +++ /dev/null @@ -1,36 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** The voices provided by Vapi */ -export const FallbackVapiVoiceVoiceId = { - Clara: "Clara", - Godfrey: "Godfrey", - Layla: "Layla", - Sid: "Sid", - Gustavo: "Gustavo", - Elliot: "Elliot", - Kylie: "Kylie", - Rohan: "Rohan", - Lily: "Lily", - Savannah: "Savannah", - Hana: "Hana", - Neha: "Neha", - Cole: "Cole", - Harry: "Harry", - Paige: "Paige", - Spencer: "Spencer", - Nico: "Nico", - Kai: "Kai", - Emma: "Emma", - Sagar: "Sagar", - Neil: "Neil", - Naina: "Naina", - Leah: "Leah", - Tara: "Tara", - Jess: "Jess", - Leo: "Leo", - Dan: "Dan", - Mia: "Mia", - Zac: "Zac", - Zoe: "Zoe", -} as const; -export type FallbackVapiVoiceVoiceId = (typeof FallbackVapiVoiceVoiceId)[keyof typeof FallbackVapiVoiceVoiceId]; diff --git a/src/api/types/FallbackWellSaidVoice.ts b/src/api/types/FallbackWellSaidVoice.ts index 141ef0e9..d8a2d5b2 100644 --- a/src/api/types/FallbackWellSaidVoice.ts +++ b/src/api/types/FallbackWellSaidVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fallback configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, and caching. + */ export interface FallbackWellSaidVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/FallbackXaiTranscriber.ts b/src/api/types/FallbackXaiTranscriber.ts new file mode 100644 index 00000000..ccd4d97a --- /dev/null +++ b/src/api/types/FallbackXaiTranscriber.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface FallbackXaiTranscriber { + /** The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection. */ + model?: Vapi.FallbackXaiTranscriberModel | undefined; + /** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). Defaults to `en` if not set. xAI auto-detects when omitted via the API but Vapi defaults to English for deterministic behavior. */ + language?: Vapi.FallbackXaiTranscriberLanguage | undefined; +} diff --git a/src/api/types/FallbackXaiTranscriberLanguage.ts b/src/api/types/FallbackXaiTranscriberLanguage.ts new file mode 100644 index 00000000..3dbec62c --- /dev/null +++ b/src/api/types/FallbackXaiTranscriberLanguage.ts @@ -0,0 +1,32 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). Defaults to `en` if not set. xAI auto-detects when omitted via the API but Vapi defaults to English for deterministic behavior. */ +export const FallbackXaiTranscriberLanguage = { + Ar: "ar", + Cs: "cs", + Da: "da", + Nl: "nl", + En: "en", + Fil: "fil", + Fr: "fr", + De: "de", + Hi: "hi", + Id: "id", + It: "it", + Ja: "ja", + Ko: "ko", + Mk: "mk", + Ms: "ms", + Fa: "fa", + Pl: "pl", + Pt: "pt", + Ro: "ro", + Ru: "ru", + Es: "es", + Sv: "sv", + Th: "th", + Tr: "tr", + Vi: "vi", +} as const; +export type FallbackXaiTranscriberLanguage = + (typeof FallbackXaiTranscriberLanguage)[keyof typeof FallbackXaiTranscriberLanguage]; diff --git a/src/api/types/FallbackXaiTranscriberModel.ts b/src/api/types/FallbackXaiTranscriberModel.ts new file mode 100644 index 00000000..d38241f8 --- /dev/null +++ b/src/api/types/FallbackXaiTranscriberModel.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection. */ +export const FallbackXaiTranscriberModel = { + Default: "default", +} as const; +export type FallbackXaiTranscriberModel = + (typeof FallbackXaiTranscriberModel)[keyof typeof FallbackXaiTranscriberModel]; diff --git a/src/api/types/FallbackXaiVoice.ts b/src/api/types/FallbackXaiVoice.ts new file mode 100644 index 00000000..348077dc --- /dev/null +++ b/src/api/types/FallbackXaiVoice.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface FallbackXaiVoice { + /** This is the flag to toggle voice caching for the assistant. */ + cachingEnabled?: boolean | undefined; + /** Built-in voices: eve, ara, rex, sal, leo. Cloned voice IDs are also accepted. */ + voiceId: Vapi.FallbackXaiVoiceVoiceId; + /** BCP-47 language code for xAI TTS synthesis. */ + language?: Vapi.FallbackXaiVoiceLanguage | undefined; + /** Speed multiplier for xAI TTS synthesis. */ + speed?: number | undefined; + /** This is the plan for chunking the model output before it is sent to the voice provider. */ + chunkPlan?: Vapi.ChunkPlan | undefined; +} diff --git a/src/api/types/FallbackXaiVoiceLanguage.ts b/src/api/types/FallbackXaiVoiceLanguage.ts new file mode 100644 index 00000000..05cf8347 --- /dev/null +++ b/src/api/types/FallbackXaiVoiceLanguage.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +/** BCP-47 language code for xAI TTS synthesis. */ +export const FallbackXaiVoiceLanguage = { + Auto: "auto", + En: "en", + ArEg: "ar-EG", + ArSa: "ar-SA", + ArAe: "ar-AE", + Bn: "bn", + Zh: "zh", + Fr: "fr", + De: "de", + Hi: "hi", + Id: "id", + It: "it", + Ja: "ja", + Ko: "ko", + PtBr: "pt-BR", + PtPt: "pt-PT", + Ru: "ru", + EsMx: "es-MX", + EsEs: "es-ES", + Tr: "tr", + Vi: "vi", +} as const; +export type FallbackXaiVoiceLanguage = (typeof FallbackXaiVoiceLanguage)[keyof typeof FallbackXaiVoiceLanguage]; diff --git a/src/api/types/FallbackXaiVoiceVoiceId.ts b/src/api/types/FallbackXaiVoiceVoiceId.ts new file mode 100644 index 00000000..0f1ed580 --- /dev/null +++ b/src/api/types/FallbackXaiVoiceVoiceId.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Built-in voices: eve, ara, rex, sal, leo. Cloned voice IDs are also accepted. */ +export const FallbackXaiVoiceVoiceId = { + Eve: "eve", + Ara: "ara", + Rex: "rex", + Sal: "sal", + Leo: "leo", +} as const; +export type FallbackXaiVoiceVoiceId = (typeof FallbackXaiVoiceVoiceId)[keyof typeof FallbackXaiVoiceVoiceId]; diff --git a/src/api/types/FileObject.ts b/src/api/types/FileObject.ts index b4aa566a..cb37ac84 100644 --- a/src/api/types/FileObject.ts +++ b/src/api/types/FileObject.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The object type. This is always `file`. */ export const FileObject = { File: "file", } as const; diff --git a/src/api/types/FileStatus.ts b/src/api/types/FileStatus.ts index a6a168cf..c8a5285e 100644 --- a/src/api/types/FileStatus.ts +++ b/src/api/types/FileStatus.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The current processing status of the uploaded file. */ export const FileStatus = { Processing: "processing", Done: "done", diff --git a/src/api/types/File_.ts b/src/api/types/File_.ts index 1e5228d7..e2d2d74c 100644 --- a/src/api/types/File_.ts +++ b/src/api/types/File_.ts @@ -2,21 +2,37 @@ import type * as Vapi from "../index.js"; +/** + * An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and lifecycle timestamps. + */ export interface File_ { + /** The object type. This is always `file`. */ object?: Vapi.FileObject | undefined; + /** The current processing status of the uploaded file. */ status?: Vapi.FileStatus | undefined; /** This is the name of the file. This is just for your own reference. */ name?: string | undefined; + /** The original name of the uploaded file. */ originalName?: string | undefined; + /** The size of the uploaded file in bytes. */ bytes?: number | undefined; + /** The intended use assigned to the uploaded file. */ purpose?: string | undefined; + /** The MIME type of the uploaded file. */ mimetype?: string | undefined; + /** The object-storage key for the uploaded file. */ key?: string | undefined; + /** The object-storage path for the uploaded file. */ path?: string | undefined; + /** The object-storage bucket containing the uploaded file. */ bucket?: string | undefined; + /** The URL used to access the uploaded file. */ url?: string | undefined; + /** The URL used to access text extracted from the file. */ parsedTextUrl?: string | undefined; + /** The size of the extracted text in bytes. */ parsedTextBytes?: number | undefined; + /** Additional metadata associated with the uploaded file. */ metadata?: Record | undefined; /** This is the unique identifier for the file. */ id: string; diff --git a/src/api/types/FilterDateTypeColumnOnCallTable.ts b/src/api/types/FilterDateTypeColumnOnCallTable.ts index c3b58c8b..4e134861 100644 --- a/src/api/types/FilterDateTypeColumnOnCallTable.ts +++ b/src/api/types/FilterDateTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing a start or end timestamp with a date. + */ export interface FilterDateTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts b/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts index a6ee7e63..3390d3fc 100644 --- a/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts +++ b/src/api/types/FilterNumberArrayTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters numeric call fields using a list of values or an emptiness test. + */ export interface FilterNumberArrayTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterNumberTypeColumnOnCallTable.ts b/src/api/types/FilterNumberTypeColumnOnCallTable.ts index d9337120..3f9aa4e1 100644 --- a/src/api/types/FilterNumberTypeColumnOnCallTable.ts +++ b/src/api/types/FilterNumberTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing a numeric field with a value. + */ export interface FilterNumberTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts b/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts index 235000b8..e803a97e 100644 --- a/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts +++ b/src/api/types/FilterStringArrayTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters string-valued call fields using a list of values or an emptiness test. + */ export interface FilterStringArrayTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStringTypeColumnOnCallTable.ts b/src/api/types/FilterStringTypeColumnOnCallTable.ts index 5e7d0dc9..534a862f 100644 --- a/src/api/types/FilterStringTypeColumnOnCallTable.ts +++ b/src/api/types/FilterStringTypeColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters call records by comparing or searching a string-valued field. + */ export interface FilterStringTypeColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FilterStructuredOutputColumnOnCallTable.ts b/src/api/types/FilterStructuredOutputColumnOnCallTable.ts index e6b8a1bc..6fab5dfc 100644 --- a/src/api/types/FilterStructuredOutputColumnOnCallTable.ts +++ b/src/api/types/FilterStructuredOutputColumnOnCallTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness operators. + */ export interface FilterStructuredOutputColumnOnCallTable { /** * This is the column in the call table that will be filtered on. diff --git a/src/api/types/FormatPlan.ts b/src/api/types/FormatPlan.ts index b929ddf5..87b18a56 100644 --- a/src/api/types/FormatPlan.ts +++ b/src/api/types/FormatPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom replacements. + */ export interface FormatPlan { /** * This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`. diff --git a/src/api/types/FourierDenoisingPlan.ts b/src/api/types/FourierDenoisingPlan.ts index e25f739a..d5609771 100644 --- a/src/api/types/FourierDenoisingPlan.ts +++ b/src/api/types/FourierDenoisingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis window. + */ export interface FourierDenoisingPlan { /** Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected. */ enabled?: boolean | undefined; diff --git a/src/api/types/FunctionCallHookAction.ts b/src/api/types/FunctionCallHookAction.ts index 1271a135..5d163ce1 100644 --- a/src/api/types/FunctionCallHookAction.ts +++ b/src/api/types/FunctionCallHookAction.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface FunctionCallHookAction { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.FunctionCallHookActionMessagesItem[] | undefined; /** The type of tool. "function" for Function tool. */ type: Vapi.FunctionCallHookActionType; diff --git a/src/api/types/FunctionTool.ts b/src/api/types/FunctionTool.ts index 40fce552..77a24ac9 100644 --- a/src/api/types/FunctionTool.ts +++ b/src/api/types/FunctionTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant. + */ export interface FunctionTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.FunctionToolMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/FunctionToolWithToolCall.ts b/src/api/types/FunctionToolWithToolCall.ts index 77a1552f..39096927 100644 --- a/src/api/types/FunctionToolWithToolCall.ts +++ b/src/api/types/FunctionToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface FunctionToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.FunctionToolWithToolCallMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/GcpKey.ts b/src/api/types/GcpKey.ts index bc65d9bf..af2469e4 100644 --- a/src/api/types/GcpKey.ts +++ b/src/api/types/GcpKey.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Google Cloud service-account key used to authenticate access to Google Cloud resources. + */ export interface GcpKey { /** This is the type of the key. Most likely, this is "service_account". */ type: string; diff --git a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts index c8072496..3746a0f9 100644 --- a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts +++ b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Selects a prebuilt voice for Gemini Multimodal Live audio output. + */ export interface GeminiMultimodalLivePrebuiltVoiceConfig { + /** Prebuilt Gemini voice used for audio output. */ voiceName: Vapi.GeminiMultimodalLivePrebuiltVoiceConfigVoiceName; } diff --git a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts index 69367fdf..68b6984a 100644 --- a/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts +++ b/src/api/types/GeminiMultimodalLivePrebuiltVoiceConfigVoiceName.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Prebuilt Gemini voice used for audio output. */ export const GeminiMultimodalLivePrebuiltVoiceConfigVoiceName = { Puck: "Puck", Charon: "Charon", diff --git a/src/api/types/GeminiMultimodalLiveSpeechConfig.ts b/src/api/types/GeminiMultimodalLiveSpeechConfig.ts index 4a04e9df..4d946c4a 100644 --- a/src/api/types/GeminiMultimodalLiveSpeechConfig.ts +++ b/src/api/types/GeminiMultimodalLiveSpeechConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Speech-output configuration for Gemini Multimodal Live. + */ export interface GeminiMultimodalLiveSpeechConfig { + /** Voice configuration used for Gemini Multimodal Live speech output. */ voiceConfig: Vapi.GeminiMultimodalLiveVoiceConfig; } diff --git a/src/api/types/GeminiMultimodalLiveVoiceConfig.ts b/src/api/types/GeminiMultimodalLiveVoiceConfig.ts index 66873c91..07631452 100644 --- a/src/api/types/GeminiMultimodalLiveVoiceConfig.ts +++ b/src/api/types/GeminiMultimodalLiveVoiceConfig.ts @@ -2,6 +2,10 @@ import type * as Vapi from "../index.js"; +/** + * Voice selection configuration for Gemini Multimodal Live. + */ export interface GeminiMultimodalLiveVoiceConfig { + /** Prebuilt voice used for Gemini Multimodal Live speech output. */ prebuiltVoiceConfig: Vapi.GeminiMultimodalLivePrebuiltVoiceConfig; } diff --git a/src/api/types/GetChatPaginatedDto.ts b/src/api/types/GetChatPaginatedDto.ts index a2c5fdd0..8d83a651 100644 --- a/src/api/types/GetChatPaginatedDto.ts +++ b/src/api/types/GetChatPaginatedDto.ts @@ -15,10 +15,14 @@ export interface GetChatPaginatedDto { sessionId?: string | undefined; /** This is the unique identifier for the previous chat to filter by. */ previousChatId?: string | undefined; + /** Filter by multiple chat IDs. Provide as comma-separated values. */ + idAny?: string | undefined; /** This is the page number to return. Defaults to 1. */ page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.GetChatPaginatedDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.GetChatPaginatedDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/GetChatPaginatedDtoSortBy.ts b/src/api/types/GetChatPaginatedDtoSortBy.ts new file mode 100644 index 00000000..c6bfc51b --- /dev/null +++ b/src/api/types/GetChatPaginatedDtoSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const GetChatPaginatedDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type GetChatPaginatedDtoSortBy = (typeof GetChatPaginatedDtoSortBy)[keyof typeof GetChatPaginatedDtoSortBy]; diff --git a/src/api/types/GetEvalPaginatedDto.ts b/src/api/types/GetEvalPaginatedDto.ts index cc4f59de..e96f1e47 100644 --- a/src/api/types/GetEvalPaginatedDto.ts +++ b/src/api/types/GetEvalPaginatedDto.ts @@ -8,6 +8,8 @@ export interface GetEvalPaginatedDto { page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.GetEvalPaginatedDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.GetEvalPaginatedDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/GetEvalPaginatedDtoSortBy.ts b/src/api/types/GetEvalPaginatedDtoSortBy.ts new file mode 100644 index 00000000..2e24f4ab --- /dev/null +++ b/src/api/types/GetEvalPaginatedDtoSortBy.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const GetEvalPaginatedDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type GetEvalPaginatedDtoSortBy = (typeof GetEvalPaginatedDtoSortBy)[keyof typeof GetEvalPaginatedDtoSortBy]; diff --git a/src/api/types/GetEvalRunPaginatedDto.ts b/src/api/types/GetEvalRunPaginatedDto.ts index e895f966..1c78dd6d 100644 --- a/src/api/types/GetEvalRunPaginatedDto.ts +++ b/src/api/types/GetEvalRunPaginatedDto.ts @@ -8,6 +8,8 @@ export interface GetEvalRunPaginatedDto { page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.GetEvalRunPaginatedDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.GetEvalRunPaginatedDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/GetEvalRunPaginatedDtoSortBy.ts b/src/api/types/GetEvalRunPaginatedDtoSortBy.ts new file mode 100644 index 00000000..ab9cbd26 --- /dev/null +++ b/src/api/types/GetEvalRunPaginatedDtoSortBy.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const GetEvalRunPaginatedDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type GetEvalRunPaginatedDtoSortBy = + (typeof GetEvalRunPaginatedDtoSortBy)[keyof typeof GetEvalRunPaginatedDtoSortBy]; diff --git a/src/api/types/GetSessionPaginatedDto.ts b/src/api/types/GetSessionPaginatedDto.ts index 69915e22..aff5f961 100644 --- a/src/api/types/GetSessionPaginatedDto.ts +++ b/src/api/types/GetSessionPaginatedDto.ts @@ -19,6 +19,8 @@ export interface GetSessionPaginatedDto { customer?: Vapi.CreateCustomerDto | undefined; /** Filter by any of the specified customer phone numbers (comma-separated). */ customerNumberAny?: string | undefined; + /** Filter by multiple session IDs. Provide as comma-separated values. */ + idAny?: string | undefined; /** This will return sessions with the specified phoneNumberId. */ phoneNumberId?: string | undefined; /** This will return sessions with any of the specified phoneNumberIds. */ @@ -27,6 +29,8 @@ export interface GetSessionPaginatedDto { page?: number | undefined; /** This is the sort order for pagination. Defaults to 'DESC'. */ sortOrder?: Vapi.GetSessionPaginatedDtoSortOrder | undefined; + /** This is the column to sort by. Defaults to 'createdAt'. */ + sortBy?: Vapi.GetSessionPaginatedDtoSortBy | undefined; /** This is the maximum number of items to return. Defaults to 100. */ limit?: number | undefined; /** This will return items where the createdAt is greater than the specified value. */ diff --git a/src/api/types/GetSessionPaginatedDtoSortBy.ts b/src/api/types/GetSessionPaginatedDtoSortBy.ts new file mode 100644 index 00000000..01573bb6 --- /dev/null +++ b/src/api/types/GetSessionPaginatedDtoSortBy.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the column to sort by. Defaults to 'createdAt'. */ +export const GetSessionPaginatedDtoSortBy = { + CreatedAt: "createdAt", + Duration: "duration", + Cost: "cost", +} as const; +export type GetSessionPaginatedDtoSortBy = + (typeof GetSessionPaginatedDtoSortBy)[keyof typeof GetSessionPaginatedDtoSortBy]; diff --git a/src/api/types/GetToolDraftsDto.ts b/src/api/types/GetToolDraftsDto.ts new file mode 100644 index 00000000..7ba05e67 --- /dev/null +++ b/src/api/types/GetToolDraftsDto.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface GetToolDraftsDto { + /** Opaque base64-encoded keyset cursor. Omit on first page. */ + cursor?: string | undefined; + /** Page size, defaults to 25, capped at 100. */ + limit?: number | undefined; + createdBy?: string | undefined; +} diff --git a/src/api/types/GhlTool.ts b/src/api/types/GhlTool.ts index 9429418a..52c04509 100644 --- a/src/api/types/GhlTool.ts +++ b/src/api/types/GhlTool.ts @@ -3,11 +3,8 @@ import type * as Vapi from "../index.js"; export interface GhlTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GhlToolMessagesItem[] | undefined; /** The type of tool. "ghl" for GHL tool. */ type: Vapi.GhlToolType; diff --git a/src/api/types/GhlToolMetadata.ts b/src/api/types/GhlToolMetadata.ts index 402db52d..7dd4abaa 100644 --- a/src/api/types/GhlToolMetadata.ts +++ b/src/api/types/GhlToolMetadata.ts @@ -1,6 +1,11 @@ // This file was auto-generated by Fern from our API Definition. +/** + * GHL workflow and location identifiers attached to a tool. + */ export interface GhlToolMetadata { + /** GHL workflow identifier associated with the tool. */ workflowId?: string | undefined; + /** GHL location identifier associated with the tool. */ locationId?: string | undefined; } diff --git a/src/api/types/GhlToolWithToolCall.ts b/src/api/types/GhlToolWithToolCall.ts index 272353f3..d1244d2f 100644 --- a/src/api/types/GhlToolWithToolCall.ts +++ b/src/api/types/GhlToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GhlToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GhlToolWithToolCallMessagesItem[] | undefined; toolCall: Vapi.ToolCall; metadata: Vapi.GhlToolMetadata; diff --git a/src/api/types/GladiaCustomVocabularyConfigDto.ts b/src/api/types/GladiaCustomVocabularyConfigDto.ts index 043937e6..2d134a3d 100644 --- a/src/api/types/GladiaCustomVocabularyConfigDto.ts +++ b/src/api/types/GladiaCustomVocabularyConfigDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition intensity. + */ export interface GladiaCustomVocabularyConfigDto { /** Array of vocabulary items (strings or objects with value, pronunciations, intensity, language) */ vocabulary: Vapi.GladiaCustomVocabularyConfigDtoVocabularyItem[]; diff --git a/src/api/types/GladiaTranscriber.ts b/src/api/types/GladiaTranscriber.ts index 364713e9..205bd74c 100644 --- a/src/api/types/GladiaTranscriber.ts +++ b/src/api/types/GladiaTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, audio processing, endpointing, vocabulary, region, and fallback settings. + */ export interface GladiaTranscriber { /** This is the Gladia model that will be used. Default is 'fast' */ model?: Vapi.GladiaTranscriberModel | undefined; @@ -10,7 +13,7 @@ export interface GladiaTranscriber { /** Defines the language to use for the transcription. Required when languageBehaviour is 'manual'. */ language?: Vapi.GladiaTranscriberLanguage | undefined; /** Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'. */ - languages?: Vapi.GladiaTranscriberLanguages | undefined; + languages?: Vapi.GladiaTranscriberLanguagesItem[] | undefined; /** * Provides a custom vocabulary to the model to improve accuracy of transcribing context specific words, technical terms, names, etc. If empty, this argument is ignored. * ⚠️ Warning ⚠️: Please be aware that the transcription_hint field has a character limit of 600. If you provide a transcription_hint longer than 600 characters, it will be automatically truncated to meet this limit. diff --git a/src/api/types/FallbackGladiaTranscriberLanguages.ts b/src/api/types/GladiaTranscriberLanguagesItem.ts similarity index 82% rename from src/api/types/FallbackGladiaTranscriberLanguages.ts rename to src/api/types/GladiaTranscriberLanguagesItem.ts index 4006a283..f5377e1c 100644 --- a/src/api/types/FallbackGladiaTranscriberLanguages.ts +++ b/src/api/types/GladiaTranscriberLanguagesItem.ts @@ -1,7 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** Defines the languages to use for the transcription. Required when languageBehaviour is 'manual'. */ -export const FallbackGladiaTranscriberLanguages = { +export const GladiaTranscriberLanguagesItem = { Af: "af", Sq: "sq", Am: "am", @@ -102,5 +101,5 @@ export const FallbackGladiaTranscriberLanguages = { Yi: "yi", Yo: "yo", } as const; -export type FallbackGladiaTranscriberLanguages = - (typeof FallbackGladiaTranscriberLanguages)[keyof typeof FallbackGladiaTranscriberLanguages]; +export type GladiaTranscriberLanguagesItem = + (typeof GladiaTranscriberLanguagesItem)[keyof typeof GladiaTranscriberLanguagesItem]; diff --git a/src/api/types/GladiaVocabularyItemDto.ts b/src/api/types/GladiaVocabularyItemDto.ts index 1b8e07bc..b64422af 100644 --- a/src/api/types/GladiaVocabularyItemDto.ts +++ b/src/api/types/GladiaVocabularyItemDto.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language. + */ export interface GladiaVocabularyItemDto { /** The vocabulary word or phrase */ value: string; diff --git a/src/api/types/GlobalNodePlan.ts b/src/api/types/GlobalNodePlan.ts index d03f57b6..bdd73f0b 100644 --- a/src/api/types/GlobalNodePlan.ts +++ b/src/api/types/GlobalNodePlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether a conversation node can be entered globally and the condition evaluated before that node runs. + */ export interface GlobalNodePlan { /** * This is the flag to determine if this node is a global node diff --git a/src/api/types/GoHighLevelCalendarAvailabilityTool.ts b/src/api/types/GoHighLevelCalendarAvailabilityTool.ts index 0c361ae0..184f3653 100644 --- a/src/api/types/GoHighLevelCalendarAvailabilityTool.ts +++ b/src/api/types/GoHighLevelCalendarAvailabilityTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that checks calendar availability in a connected GoHighLevel account. + */ export interface GoHighLevelCalendarAvailabilityTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelCalendarAvailabilityToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoHighLevelCalendarAvailabilityToolWithToolCall.ts b/src/api/types/GoHighLevelCalendarAvailabilityToolWithToolCall.ts index 98a72adc..81627c6f 100644 --- a/src/api/types/GoHighLevelCalendarAvailabilityToolWithToolCall.ts +++ b/src/api/types/GoHighLevelCalendarAvailabilityToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoHighLevelCalendarAvailabilityToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelCalendarAvailabilityToolWithToolCallMessagesItem[] | undefined; /** The type of tool. "gohighlevel.calendar.availability.check" for GoHighLevel Calendar Availability Check tool. */ type: Vapi.GoHighLevelCalendarAvailabilityToolWithToolCallType; diff --git a/src/api/types/GoHighLevelCalendarEventCreateTool.ts b/src/api/types/GoHighLevelCalendarEventCreateTool.ts index 3c927271..bfdca1d8 100644 --- a/src/api/types/GoHighLevelCalendarEventCreateTool.ts +++ b/src/api/types/GoHighLevelCalendarEventCreateTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds calendar events to a connected GoHighLevel account. + */ export interface GoHighLevelCalendarEventCreateTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelCalendarEventCreateToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoHighLevelCalendarEventCreateToolWithToolCall.ts b/src/api/types/GoHighLevelCalendarEventCreateToolWithToolCall.ts index e2f45e40..ce923744 100644 --- a/src/api/types/GoHighLevelCalendarEventCreateToolWithToolCall.ts +++ b/src/api/types/GoHighLevelCalendarEventCreateToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoHighLevelCalendarEventCreateToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelCalendarEventCreateToolWithToolCallMessagesItem[] | undefined; /** The type of tool. "gohighlevel.calendar.event.create" for GoHighLevel Calendar Event Create tool. */ type: Vapi.GoHighLevelCalendarEventCreateToolWithToolCallType; diff --git a/src/api/types/GoHighLevelContactCreateTool.ts b/src/api/types/GoHighLevelContactCreateTool.ts index 378ec1ef..08510abc 100644 --- a/src/api/types/GoHighLevelContactCreateTool.ts +++ b/src/api/types/GoHighLevelContactCreateTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds contacts to a connected GoHighLevel account. + */ export interface GoHighLevelContactCreateTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelContactCreateToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoHighLevelContactCreateToolWithToolCall.ts b/src/api/types/GoHighLevelContactCreateToolWithToolCall.ts index a27472db..a1497e58 100644 --- a/src/api/types/GoHighLevelContactCreateToolWithToolCall.ts +++ b/src/api/types/GoHighLevelContactCreateToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoHighLevelContactCreateToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelContactCreateToolWithToolCallMessagesItem[] | undefined; /** The type of tool. "gohighlevel.contact.create" for GoHighLevel Contact Create tool. */ type: Vapi.GoHighLevelContactCreateToolWithToolCallType; diff --git a/src/api/types/GoHighLevelContactGetTool.ts b/src/api/types/GoHighLevelContactGetTool.ts index a00261b7..87e49735 100644 --- a/src/api/types/GoHighLevelContactGetTool.ts +++ b/src/api/types/GoHighLevelContactGetTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that retrieves contacts from a connected GoHighLevel account. + */ export interface GoHighLevelContactGetTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelContactGetToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoHighLevelContactGetToolWithToolCall.ts b/src/api/types/GoHighLevelContactGetToolWithToolCall.ts index a987f9f3..28ca816f 100644 --- a/src/api/types/GoHighLevelContactGetToolWithToolCall.ts +++ b/src/api/types/GoHighLevelContactGetToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoHighLevelContactGetToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoHighLevelContactGetToolWithToolCallMessagesItem[] | undefined; /** The type of tool. "gohighlevel.contact.get" for GoHighLevel Contact Get tool. */ type: Vapi.GoHighLevelContactGetToolWithToolCallType; diff --git a/src/api/types/GoogleCalendarCheckAvailabilityTool.ts b/src/api/types/GoogleCalendarCheckAvailabilityTool.ts index 5f2ea106..e0f65e67 100644 --- a/src/api/types/GoogleCalendarCheckAvailabilityTool.ts +++ b/src/api/types/GoogleCalendarCheckAvailabilityTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that checks availability in a connected Google Calendar. + */ export interface GoogleCalendarCheckAvailabilityTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoogleCalendarCheckAvailabilityToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoogleCalendarCreateEventTool.ts b/src/api/types/GoogleCalendarCreateEventTool.ts index d13b6394..879c0f3e 100644 --- a/src/api/types/GoogleCalendarCreateEventTool.ts +++ b/src/api/types/GoogleCalendarCreateEventTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that adds events to a connected Google Calendar. + */ export interface GoogleCalendarCreateEventTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoogleCalendarCreateEventToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoogleCalendarCreateEventToolWithToolCall.ts b/src/api/types/GoogleCalendarCreateEventToolWithToolCall.ts index 5ae1d87f..3628ff4e 100644 --- a/src/api/types/GoogleCalendarCreateEventToolWithToolCall.ts +++ b/src/api/types/GoogleCalendarCreateEventToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoogleCalendarCreateEventToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoogleCalendarCreateEventToolWithToolCallMessagesItem[] | undefined; toolCall: Vapi.ToolCall; /** diff --git a/src/api/types/GoogleModel.ts b/src/api/types/GoogleModel.ts index 65f789eb..9df80aac 100644 --- a/src/api/types/GoogleModel.ts +++ b/src/api/types/GoogleModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base access, realtime settings, and generation settings. + */ export interface GoogleModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,6 +20,13 @@ export interface GoogleModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the Google model that will be used. */ @@ -26,7 +36,7 @@ export interface GoogleModel { * Only applicable if the model `gemini-2.0-flash-realtime-exp` is selected. */ realtimeConfig?: Vapi.GoogleRealtimeConfig | undefined; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/GoogleModelModel.ts b/src/api/types/GoogleModelModel.ts index dc8a2542..f70daec7 100644 --- a/src/api/types/GoogleModelModel.ts +++ b/src/api/types/GoogleModelModel.ts @@ -2,6 +2,8 @@ /** This is the Google model that will be used. */ export const GoogleModelModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/GoogleModelToolsItem.ts b/src/api/types/GoogleModelToolsItem.ts index ae100a47..bade80ef 100644 --- a/src/api/types/GoogleModelToolsItem.ts +++ b/src/api/types/GoogleModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace GoogleModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.GoogleModelToolsItem.ApiRequest + | Vapi.GoogleModelToolsItem.Bash + | Vapi.GoogleModelToolsItem.Code + | Vapi.GoogleModelToolsItem.Computer + | Vapi.GoogleModelToolsItem.Dtmf + | Vapi.GoogleModelToolsItem.EndCall + | Vapi.GoogleModelToolsItem.Function + | Vapi.GoogleModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.GoogleModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.GoogleModelToolsItem.GohighlevelContactCreate + | Vapi.GoogleModelToolsItem.GohighlevelContactGet + | Vapi.GoogleModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.GoogleModelToolsItem.GoogleCalendarEventCreate + | Vapi.GoogleModelToolsItem.GoogleSheetsRowAppend + | Vapi.GoogleModelToolsItem.Handoff + | Vapi.GoogleModelToolsItem.Mcp + | Vapi.GoogleModelToolsItem.Query + | Vapi.GoogleModelToolsItem.SlackMessageSend + | Vapi.GoogleModelToolsItem.Sms + | Vapi.GoogleModelToolsItem.TextEditor + | Vapi.GoogleModelToolsItem.TransferCall + | Vapi.GoogleModelToolsItem.SipRequest + | Vapi.GoogleModelToolsItem.Voicemail; } diff --git a/src/api/types/GoogleRealtimeConfig.ts b/src/api/types/GoogleRealtimeConfig.ts index ded46199..ae24d85b 100644 --- a/src/api/types/GoogleRealtimeConfig.ts +++ b/src/api/types/GoogleRealtimeConfig.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice configuration. + */ export interface GoogleRealtimeConfig { /** * This is the nucleus sampling parameter that controls the cumulative probability of tokens considered during text generation. diff --git a/src/api/types/GoogleSheetsRowAppendTool.ts b/src/api/types/GoogleSheetsRowAppendTool.ts index b1ee489f..54d8cc33 100644 --- a/src/api/types/GoogleSheetsRowAppendTool.ts +++ b/src/api/types/GoogleSheetsRowAppendTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that appends rows to a connected Google Sheet. + */ export interface GoogleSheetsRowAppendTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoogleSheetsRowAppendToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/GoogleSheetsRowAppendToolWithToolCall.ts b/src/api/types/GoogleSheetsRowAppendToolWithToolCall.ts index 903468fb..0c20ab3b 100644 --- a/src/api/types/GoogleSheetsRowAppendToolWithToolCall.ts +++ b/src/api/types/GoogleSheetsRowAppendToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface GoogleSheetsRowAppendToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.GoogleSheetsRowAppendToolWithToolCallMessagesItem[] | undefined; /** The type of tool. "google.sheets.row.append" for Google Sheets Row Append tool. */ type: Vapi.GoogleSheetsRowAppendToolWithToolCallType; diff --git a/src/api/types/GoogleTranscriber.ts b/src/api/types/GoogleTranscriber.ts index e11438d9..b38799c4 100644 --- a/src/api/types/GoogleTranscriber.ts +++ b/src/api/types/GoogleTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Google, including model, language, and fallback settings. + */ export interface GoogleTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.GoogleTranscriberModel | undefined; diff --git a/src/api/types/GoogleTranscriberModel.ts b/src/api/types/GoogleTranscriberModel.ts index e3b38a70..ef981704 100644 --- a/src/api/types/GoogleTranscriberModel.ts +++ b/src/api/types/GoogleTranscriberModel.ts @@ -2,6 +2,8 @@ /** This is the model that will be used for the transcription. */ export const GoogleTranscriberModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/GoogleVoicemailDetectionPlan.ts b/src/api/types/GoogleVoicemailDetectionPlan.ts index cb958d65..52049314 100644 --- a/src/api/types/GoogleVoicemailDetectionPlan.ts +++ b/src/api/types/GoogleVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff. + */ export interface GoogleVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/GroqModel.ts b/src/api/types/GroqModel.ts index 6111679c..aec1ce95 100644 --- a/src/api/types/GroqModel.ts +++ b/src/api/types/GroqModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface GroqModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface GroqModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.GroqModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/GroqModelModel.ts b/src/api/types/GroqModelModel.ts index b13dda82..58a6b9e1 100644 --- a/src/api/types/GroqModelModel.ts +++ b/src/api/types/GroqModelModel.ts @@ -12,7 +12,6 @@ export const GroqModelModel = { Llama370B8192: "llama3-70b-8192", Gemma29BIt: "gemma2-9b-it", MoonshotaiKimiK2Instruct0905: "moonshotai/kimi-k2-instruct-0905", - MetaLlamaLlama4Maverick17B128EInstruct: "meta-llama/llama-4-maverick-17b-128e-instruct", MetaLlamaLlama4Scout17B16EInstruct: "meta-llama/llama-4-scout-17b-16e-instruct", MistralSaba24B: "mistral-saba-24b", CompoundBeta: "compound-beta", diff --git a/src/api/types/GroqModelToolsItem.ts b/src/api/types/GroqModelToolsItem.ts index f6cdeb94..764e8e55 100644 --- a/src/api/types/GroqModelToolsItem.ts +++ b/src/api/types/GroqModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace GroqModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.GroqModelToolsItem.ApiRequest + | Vapi.GroqModelToolsItem.Bash + | Vapi.GroqModelToolsItem.Code + | Vapi.GroqModelToolsItem.Computer + | Vapi.GroqModelToolsItem.Dtmf + | Vapi.GroqModelToolsItem.EndCall + | Vapi.GroqModelToolsItem.Function + | Vapi.GroqModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.GroqModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.GroqModelToolsItem.GohighlevelContactCreate + | Vapi.GroqModelToolsItem.GohighlevelContactGet + | Vapi.GroqModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.GroqModelToolsItem.GoogleCalendarEventCreate + | Vapi.GroqModelToolsItem.GoogleSheetsRowAppend + | Vapi.GroqModelToolsItem.Handoff + | Vapi.GroqModelToolsItem.Mcp + | Vapi.GroqModelToolsItem.Query + | Vapi.GroqModelToolsItem.SlackMessageSend + | Vapi.GroqModelToolsItem.Sms + | Vapi.GroqModelToolsItem.TextEditor + | Vapi.GroqModelToolsItem.TransferCall + | Vapi.GroqModelToolsItem.SipRequest + | Vapi.GroqModelToolsItem.Voicemail; } diff --git a/src/api/types/GroupCondition.ts b/src/api/types/GroupCondition.ts index 74807bc4..7e337a76 100644 --- a/src/api/types/GroupCondition.ts +++ b/src/api/types/GroupCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator. + */ export interface GroupCondition { /** This is the logical operator for combining conditions in this group */ operator: Vapi.GroupConditionOperator; diff --git a/src/api/types/HandoffDestinationAssistant.ts b/src/api/types/HandoffDestinationAssistant.ts index 8c702267..5d86eb0e 100644 --- a/src/api/types/HandoffDestinationAssistant.ts +++ b/src/api/types/HandoffDestinationAssistant.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and assistant overrides. + */ export interface HandoffDestinationAssistant { + /** Selects an assistant as the handoff destination. */ type: Vapi.HandoffDestinationAssistantType; /** This is the plan for manipulating the message context before handing off the call to the next assistant. */ contextEngineeringPlan?: Vapi.HandoffDestinationAssistantContextEngineeringPlan | undefined; diff --git a/src/api/types/HandoffDestinationAssistantContextEngineeringPlan.ts b/src/api/types/HandoffDestinationAssistantContextEngineeringPlan.ts index 6b14f418..54e3680a 100644 --- a/src/api/types/HandoffDestinationAssistantContextEngineeringPlan.ts +++ b/src/api/types/HandoffDestinationAssistantContextEngineeringPlan.ts @@ -9,7 +9,8 @@ export type HandoffDestinationAssistantContextEngineeringPlan = | Vapi.HandoffDestinationAssistantContextEngineeringPlan.LastNMessages | Vapi.HandoffDestinationAssistantContextEngineeringPlan.None | Vapi.HandoffDestinationAssistantContextEngineeringPlan.All - | Vapi.HandoffDestinationAssistantContextEngineeringPlan.UserAndAssistantMessages; + | Vapi.HandoffDestinationAssistantContextEngineeringPlan.UserAndAssistantMessages + | Vapi.HandoffDestinationAssistantContextEngineeringPlan.PreviousAssistantMessages; export namespace HandoffDestinationAssistantContextEngineeringPlan { export interface LastNMessages extends Vapi.ContextEngineeringPlanLastNMessages { @@ -27,4 +28,8 @@ export namespace HandoffDestinationAssistantContextEngineeringPlan { export interface UserAndAssistantMessages extends Vapi.ContextEngineeringPlanUserAndAssistantMessages { type: "userAndAssistantMessages"; } + + export interface PreviousAssistantMessages extends Vapi.ContextEngineeringPlanPreviousAssistantMessages { + type: "previousAssistantMessages"; + } } diff --git a/src/api/types/HandoffDestinationAssistantType.ts b/src/api/types/HandoffDestinationAssistantType.ts index 0ed6fd24..74de23ae 100644 --- a/src/api/types/HandoffDestinationAssistantType.ts +++ b/src/api/types/HandoffDestinationAssistantType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects an assistant as the handoff destination. */ export const HandoffDestinationAssistantType = { Assistant: "assistant", } as const; diff --git a/src/api/types/HandoffDestinationDynamic.ts b/src/api/types/HandoffDestinationDynamic.ts index 07bdfe8c..2c14fc69 100644 --- a/src/api/types/HandoffDestinationDynamic.ts +++ b/src/api/types/HandoffDestinationDynamic.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Uses a webhook response to select the handoff destination at runtime. + */ export interface HandoffDestinationDynamic { /** * This is where Vapi will send the handoff-destination-request webhook in a dynamic handoff. diff --git a/src/api/types/HandoffDestinationSquad.ts b/src/api/types/HandoffDestinationSquad.ts index cf6d630b..f9d71ebd 100644 --- a/src/api/types/HandoffDestinationSquad.ts +++ b/src/api/types/HandoffDestinationSquad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable extraction, and overrides. + */ export interface HandoffDestinationSquad { /** This is the plan for manipulating the message context before handing off the call to the squad. */ contextEngineeringPlan?: Vapi.HandoffDestinationSquadContextEngineeringPlan | undefined; diff --git a/src/api/types/HandoffDestinationSquadContextEngineeringPlan.ts b/src/api/types/HandoffDestinationSquadContextEngineeringPlan.ts index b7e9197b..19dae006 100644 --- a/src/api/types/HandoffDestinationSquadContextEngineeringPlan.ts +++ b/src/api/types/HandoffDestinationSquadContextEngineeringPlan.ts @@ -9,7 +9,8 @@ export type HandoffDestinationSquadContextEngineeringPlan = | Vapi.HandoffDestinationSquadContextEngineeringPlan.LastNMessages | Vapi.HandoffDestinationSquadContextEngineeringPlan.None | Vapi.HandoffDestinationSquadContextEngineeringPlan.All - | Vapi.HandoffDestinationSquadContextEngineeringPlan.UserAndAssistantMessages; + | Vapi.HandoffDestinationSquadContextEngineeringPlan.UserAndAssistantMessages + | Vapi.HandoffDestinationSquadContextEngineeringPlan.PreviousAssistantMessages; export namespace HandoffDestinationSquadContextEngineeringPlan { export interface LastNMessages extends Vapi.ContextEngineeringPlanLastNMessages { @@ -27,4 +28,8 @@ export namespace HandoffDestinationSquadContextEngineeringPlan { export interface UserAndAssistantMessages extends Vapi.ContextEngineeringPlanUserAndAssistantMessages { type: "userAndAssistantMessages"; } + + export interface PreviousAssistantMessages extends Vapi.ContextEngineeringPlanPreviousAssistantMessages { + type: "previousAssistantMessages"; + } } diff --git a/src/api/types/HandoffTool.ts b/src/api/types/HandoffTool.ts index 4673c363..8c3e49b5 100644 --- a/src/api/types/HandoffTool.ts +++ b/src/api/types/HandoffTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ export interface HandoffTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.HandoffToolMessagesItem[] | undefined; /** This is the default local tool result message used when no runtime handoff result override is returned. */ defaultResult?: string | undefined; diff --git a/src/api/types/HandoffToolDestinationsItem.ts b/src/api/types/HandoffToolDestinationsItem.ts index b758672e..a2cc12d3 100644 --- a/src/api/types/HandoffToolDestinationsItem.ts +++ b/src/api/types/HandoffToolDestinationsItem.ts @@ -19,4 +19,9 @@ export namespace HandoffToolDestinationsItem { export interface Squad extends Vapi.HandoffDestinationSquad { type: "squad"; } + + export type Response = + | Vapi.HandoffToolDestinationsItem.Assistant + | Vapi.HandoffToolDestinationsItem.Dynamic + | Vapi.HandoffToolDestinationsItem.Squad; } diff --git a/src/api/types/HmacAuthenticationPlan.ts b/src/api/types/HmacAuthenticationPlan.ts index 0657f66a..d38cdd8e 100644 --- a/src/api/types/HmacAuthenticationPlan.ts +++ b/src/api/types/HmacAuthenticationPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and signature encoding. + */ export interface HmacAuthenticationPlan { /** This is the HMAC secret key used to sign requests. */ secretKey: string; diff --git a/src/api/types/HumeVoice.ts b/src/api/types/HumeVoice.ts index f9b6c7f4..78613e07 100644 --- a/src/api/types/HumeVoice.ts +++ b/src/api/types/HumeVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, caching, and fallback settings. + */ export interface HumeVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/ImportTwilioPhoneNumberDto.ts b/src/api/types/ImportTwilioPhoneNumberDto.ts index bc3b52b1..2ab92953 100644 --- a/src/api/types/ImportTwilioPhoneNumberDto.ts +++ b/src/api/types/ImportTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, fallback destination, hooks, SMS, and server settings. + */ export interface ImportTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/InflectionAiModel.ts b/src/api/types/InflectionAiModel.ts index 350d4485..e2577153 100644 --- a/src/api/types/InflectionAiModel.ts +++ b/src/api/types/InflectionAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface InflectionAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface InflectionAiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.InflectionAiModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/InflectionAiModelToolsItem.ts b/src/api/types/InflectionAiModelToolsItem.ts index 6f65d2ac..e82885bc 100644 --- a/src/api/types/InflectionAiModelToolsItem.ts +++ b/src/api/types/InflectionAiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace InflectionAiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.InflectionAiModelToolsItem.ApiRequest + | Vapi.InflectionAiModelToolsItem.Bash + | Vapi.InflectionAiModelToolsItem.Code + | Vapi.InflectionAiModelToolsItem.Computer + | Vapi.InflectionAiModelToolsItem.Dtmf + | Vapi.InflectionAiModelToolsItem.EndCall + | Vapi.InflectionAiModelToolsItem.Function + | Vapi.InflectionAiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.InflectionAiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.InflectionAiModelToolsItem.GohighlevelContactCreate + | Vapi.InflectionAiModelToolsItem.GohighlevelContactGet + | Vapi.InflectionAiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.InflectionAiModelToolsItem.GoogleCalendarEventCreate + | Vapi.InflectionAiModelToolsItem.GoogleSheetsRowAppend + | Vapi.InflectionAiModelToolsItem.Handoff + | Vapi.InflectionAiModelToolsItem.Mcp + | Vapi.InflectionAiModelToolsItem.Query + | Vapi.InflectionAiModelToolsItem.SlackMessageSend + | Vapi.InflectionAiModelToolsItem.Sms + | Vapi.InflectionAiModelToolsItem.TextEditor + | Vapi.InflectionAiModelToolsItem.TransferCall + | Vapi.InflectionAiModelToolsItem.SipRequest + | Vapi.InflectionAiModelToolsItem.Voicemail; } diff --git a/src/api/types/Insight.ts b/src/api/types/Insight.ts index 6d0d9e48..45b1b9b0 100644 --- a/src/api/types/Insight.ts +++ b/src/api/types/Insight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle timestamps. + */ export interface Insight { /** This is the name of the Insight. */ name?: string | undefined; @@ -15,4 +18,6 @@ export interface Insight { createdAt: string; /** This is the ISO 8601 date-time string of when the Insight was last updated. */ updatedAt: string; + /** Stable server-owned identifier for system-created insights. */ + systemKey?: string | undefined; } diff --git a/src/api/types/InsightFormula.ts b/src/api/types/InsightFormula.ts index 12b9550e..521981c9 100644 --- a/src/api/types/InsightFormula.ts +++ b/src/api/types/InsightFormula.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A formula used to calculate an insight from its query results, with an optional display name. + */ export interface InsightFormula { /** * This is the name of the formula. diff --git a/src/api/types/InsightPaginatedResponse.ts b/src/api/types/InsightPaginatedResponse.ts index 66bb4c8a..4870e860 100644 --- a/src/api/types/InsightPaginatedResponse.ts +++ b/src/api/types/InsightPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of saved reporting insights and metadata describing the result set. + */ export interface InsightPaginatedResponse { + /** The reporting insights returned for the current page. */ results: Vapi.Insight[]; + /** Pagination metadata for the insight result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/InsightRunFormatPlan.ts b/src/api/types/InsightRunFormatPlan.ts index 89a4dd5b..88b5eb44 100644 --- a/src/api/types/InsightRunFormatPlan.ts +++ b/src/api/types/InsightRunFormatPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects whether an insight run returns raw data or Recharts-formatted data. + */ export interface InsightRunFormatPlan { /** * This is the format of the data to return. diff --git a/src/api/types/InsightRunResponse.ts b/src/api/types/InsightRunResponse.ts index f87c3ab9..0fd9c465 100644 --- a/src/api/types/InsightRunResponse.ts +++ b/src/api/types/InsightRunResponse.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Metadata identifying a saved insight run and its lifecycle timestamps. + */ export interface InsightRunResponse { + /** The unique identifier for the insight run. */ id: string; + /** The unique identifier for the insight that was run. */ insightId: string; + /** The unique identifier for the organization that owns the run. */ orgId: string; + /** The ISO 8601 timestamp when the insight run was created. */ createdAt: string; + /** The ISO 8601 timestamp when the insight run was last updated. */ updatedAt: string; } diff --git a/src/api/types/InsightTimeRange.ts b/src/api/types/InsightTimeRange.ts index 152c08ae..ae7bf1f7 100644 --- a/src/api/types/InsightTimeRange.ts +++ b/src/api/types/InsightTimeRange.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Start, end, and timezone used to limit an insight query by time. + */ export interface InsightTimeRange { /** * This is the start date for the time range. diff --git a/src/api/types/InsightTimeRangeWithStep.ts b/src/api/types/InsightTimeRangeWithStep.ts index 582e74c8..1aabda09 100644 --- a/src/api/types/InsightTimeRangeWithStep.ts +++ b/src/api/types/InsightTimeRangeWithStep.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Start, end, timezone, and aggregation step used for a time-series insight query. + */ export interface InsightTimeRangeWithStep { /** * This is the group by step for aggregation. diff --git a/src/api/types/InviteUserDtoRole.ts b/src/api/types/InviteUserDtoRole.ts index 08ed6215..a992218c 100644 --- a/src/api/types/InviteUserDtoRole.ts +++ b/src/api/types/InviteUserDtoRole.ts @@ -1,8 +1,5 @@ // This file was auto-generated by Fern from our API Definition. -export const InviteUserDtoRole = { - Admin: "admin", - Editor: "editor", - Viewer: "viewer", -} as const; -export type InviteUserDtoRole = (typeof InviteUserDtoRole)[keyof typeof InviteUserDtoRole]; +import type * as Vapi from "../index.js"; + +export type InviteUserDtoRole = Vapi.InviteUserDtoRoleZero | string; diff --git a/src/api/types/InviteUserDtoRoleZero.ts b/src/api/types/InviteUserDtoRoleZero.ts new file mode 100644 index 00000000..0276a9ec --- /dev/null +++ b/src/api/types/InviteUserDtoRoleZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const InviteUserDtoRoleZero = { + Admin: "admin", + Editor: "editor", + Viewer: "viewer", +} as const; +export type InviteUserDtoRoleZero = (typeof InviteUserDtoRoleZero)[keyof typeof InviteUserDtoRoleZero]; diff --git a/src/api/types/InworldVoice.ts b/src/api/types/InworldVoice.ts index a220ce56..c5341ac8 100644 --- a/src/api/types/InworldVoice.ts +++ b/src/api/types/InworldVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, caching, and fallback settings. + */ export interface InworldVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts b/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts index cb0bb7a1..0ae0feed 100644 --- a/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithNumberTypeColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that aggregates a numeric call-table column with optional call filters. + */ export interface JsonQueryOnCallTableWithNumberTypeColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithNumberTypeColumnType; diff --git a/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts b/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts index ccd45824..dbcd7461 100644 --- a/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithStringTypeColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that counts values from a string-valued call-table column with optional call filters. + */ export interface JsonQueryOnCallTableWithStringTypeColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithStringTypeColumnType; diff --git a/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts b/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts index d24a8092..6e1432e1 100644 --- a/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts +++ b/src/api/types/JsonQueryOnCallTableWithStructuredOutputColumn.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that aggregates or counts a structured-output value stored on call records. + */ export interface JsonQueryOnCallTableWithStructuredOutputColumn { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnCallTableWithStructuredOutputColumnType; diff --git a/src/api/types/JsonQueryOnEventsTable.ts b/src/api/types/JsonQueryOnEventsTable.ts index 4394532e..a060dfc6 100644 --- a/src/api/types/JsonQueryOnEventsTable.ts +++ b/src/api/types/JsonQueryOnEventsTable.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data filters. + */ export interface JsonQueryOnEventsTable { /** This is the type of query. Only allowed type is "vapiql-json". */ type: Vapi.JsonQueryOnEventsTableType; diff --git a/src/api/types/JsonQueryOnEventsTableOn.ts b/src/api/types/JsonQueryOnEventsTableOn.ts index 6c67fe2a..a6ec0f47 100644 --- a/src/api/types/JsonQueryOnEventsTableOn.ts +++ b/src/api/types/JsonQueryOnEventsTableOn.ts @@ -86,7 +86,11 @@ export const JsonQueryOnEventsTableOn = { AssistantTranscriberClearing: "assistant.transcriber.clearing", AssistantTranscriberTranscriptIgnored: "assistant.transcriber.transcriptIgnored", AssistantTranscriberLanguageSwitched: "assistant.transcriber.languageSwitched", + AssistantAnalysisStructuredOutputRequest: "assistant.analysis.structuredOutputRequest", + AssistantAnalysisStructuredOutputResponse: "assistant.analysis.structuredOutputResponse", + AssistantAnalysisStructuredOutputError: "assistant.analysis.structuredOutputError", AssistantAnalysisStructuredOutputGenerated: "assistant.analysis.structuredOutputGenerated", + AssistantAnalysisStructuredOutputSkipped: "assistant.analysis.structuredOutputSkipped", PipelineTurnStarted: "pipeline.turnStarted", PipelineCleared: "pipeline.cleared", PipelineBotSpeechStarted: "pipeline.botSpeechStarted", diff --git a/src/api/types/JsonSchema.ts b/src/api/types/JsonSchema.ts index a25fa920..5cf1516c 100644 --- a/src/api/types/JsonSchema.ts +++ b/src/api/types/JsonSchema.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * JSON Schema definition used to describe structured data for extraction, validation, or model output. + */ export interface JsonSchema { /** * This is the type of output you'd like. diff --git a/src/api/types/KeypadInputPlan.ts b/src/api/types/KeypadInputPlan.ts index c458d652..95d046fe 100644 --- a/src/api/types/KeypadInputPlan.ts +++ b/src/api/types/KeypadInputPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, and delimiters. + */ export interface KeypadInputPlan { /** * This keeps track of whether the user has enabled keypad input. diff --git a/src/api/types/KnowledgeBase.ts b/src/api/types/KnowledgeBase.ts index 843d77f0..19bdf467 100644 --- a/src/api/types/KnowledgeBase.ts +++ b/src/api/types/KnowledgeBase.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A knowledge-base configuration, including its provider, model, description, and associated files. + */ export interface KnowledgeBase { /** The name of the knowledge base */ name: string; diff --git a/src/api/types/KnowledgeBaseCost.ts b/src/api/types/KnowledgeBaseCost.ts index fa99b82d..191fb4f5 100644 --- a/src/api/types/KnowledgeBaseCost.ts +++ b/src/api/types/KnowledgeBaseCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Knowledge-base model cost, including model, token usage, and amount. + */ export interface KnowledgeBaseCost { /** This is the model that was used for processing the knowledge base. */ model: Record; diff --git a/src/api/types/KnowledgeBaseModel.ts b/src/api/types/KnowledgeBaseModel.ts index 63f876d2..8588d15b 100644 --- a/src/api/types/KnowledgeBaseModel.ts +++ b/src/api/types/KnowledgeBaseModel.ts @@ -2,6 +2,8 @@ /** The model to use for the knowledge base */ export const KnowledgeBaseModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/KnowledgeBaseTool.ts b/src/api/types/KnowledgeBaseTool.ts new file mode 100644 index 00000000..4517ac6c --- /dev/null +++ b/src/api/types/KnowledgeBaseTool.ts @@ -0,0 +1,101 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface KnowledgeBaseTool { + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.KnowledgeBaseToolMessagesItem[] | undefined; + /** The knowledge base this tool searches. At most one search tool references a knowledge base. Deleting the base also deletes its generated tool; null references are retained only for backward compatibility and are inert. */ + knowledgeBaseId: string | null; + function: Vapi.KnowledgeBaseToolFunction; + /** This is the unique identifier for the tool. */ + id: string; + /** This is the unique identifier for the organization that this tool belongs to. */ + orgId: string; + /** This is the ISO 8601 date-time string of when the tool was created. */ + createdAt: string; + /** This is the ISO 8601 date-time string of when the tool was last updated. */ + updatedAt: string; + /** + * This is the plan to reject a tool call based on the conversation state. + * + * // Example 1: Reject endCall if user didn't say goodbye + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', + * target: { position: -1, role: 'user' }, + * negate: true // Reject if pattern does NOT match + * }] + * } + * ``` + * + * // Example 2: Reject transfer if user is actually asking a question + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '\\?', + * target: { position: -1, role: 'user' } + * }] + * } + * ``` + * + * // Example 3: Reject transfer if user didn't mention transfer recently + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 5 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' %} + * {% assign mentioned = false %} + * {% for msg in userMessages %} + * {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} + * {% assign mentioned = true %} + * {% break %} + * {% endif %} + * {% endfor %} + * {% if mentioned %} + * false + * {% else %} + * true + * {% endif %}` + * }] + * } + * ``` + * + * // Example 4: Reject endCall if the bot is looping and trying to exit + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 6 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} + * {% if userMessages.size < 3 %} + * false + * {% else %} + * {% assign msg1 = userMessages[0].content | downcase %} + * {% assign msg2 = userMessages[1].content | downcase %} + * {% assign msg3 = userMessages[2].content | downcase %} + * {% comment %} Check for repetitive messages {% endcomment %} + * {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} + * true + * {% comment %} Check for common loop phrases {% endcomment %} + * {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} + * true + * {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} + * true + * {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} + * true + * {% else %} + * false + * {% endif %} + * {% endif %}` + * }] + * } + * ``` + */ + rejectionPlan?: Vapi.ToolRejectionPlan | undefined; +} diff --git a/src/api/types/KnowledgeBaseToolFunction.ts b/src/api/types/KnowledgeBaseToolFunction.ts new file mode 100644 index 00000000..d5c9d299 --- /dev/null +++ b/src/api/types/KnowledgeBaseToolFunction.ts @@ -0,0 +1,28 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface KnowledgeBaseToolFunction { + /** + * This is the the name of the function to be called. + * + * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + */ + name: string; + /** + * This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/). + * + * @default false + */ + strict?: boolean | undefined; + /** This is the description of what the function does, used by the AI to choose when and how to call the function. */ + description: string; + /** + * These are the parameters the functions accepts, described as a JSON Schema object. + * + * See the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format. + * + * Omitting parameters defines a function with an empty parameter list. + */ + parameters: Vapi.OpenAiFunctionParameters; +} diff --git a/src/api/types/KnowledgeBaseToolMessagesItem.ts b/src/api/types/KnowledgeBaseToolMessagesItem.ts new file mode 100644 index 00000000..135bcae8 --- /dev/null +++ b/src/api/types/KnowledgeBaseToolMessagesItem.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type KnowledgeBaseToolMessagesItem = + | Vapi.KnowledgeBaseToolMessagesItem.RequestStart + | Vapi.KnowledgeBaseToolMessagesItem.RequestComplete + | Vapi.KnowledgeBaseToolMessagesItem.RequestFailed + | Vapi.KnowledgeBaseToolMessagesItem.RequestResponseDelayed; + +export namespace KnowledgeBaseToolMessagesItem { + export interface RequestStart extends Vapi.ToolMessageStart { + type: "request-start"; + } + + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } + + export interface RequestResponseDelayed extends Vapi.ToolMessageDelayed { + type: "request-response-delayed"; + } +} diff --git a/src/api/types/KnowledgeBaseV2.ts b/src/api/types/KnowledgeBaseV2.ts new file mode 100644 index 00000000..c51a2454 --- /dev/null +++ b/src/api/types/KnowledgeBaseV2.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface KnowledgeBaseV2 { + name: string; + description?: (string | null) | undefined; + id: string; + orgId: string; + createdAt: string; + updatedAt: string; +} diff --git a/src/api/types/KnowledgeBaseV2File.ts b/src/api/types/KnowledgeBaseV2File.ts new file mode 100644 index 00000000..3b9e6c38 --- /dev/null +++ b/src/api/types/KnowledgeBaseV2File.ts @@ -0,0 +1,15 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface KnowledgeBaseV2File { + id: string; + knowledgeBaseV2Id: string; + fileId: string; + fileName?: string | undefined; + mimetype?: string | undefined; + bytes?: number | undefined; + status: Vapi.KnowledgeBaseV2FileStatus; + createdAt: string; + updatedAt: string; +} diff --git a/src/api/types/KnowledgeBaseV2FileStatus.ts b/src/api/types/KnowledgeBaseV2FileStatus.ts new file mode 100644 index 00000000..3931936a --- /dev/null +++ b/src/api/types/KnowledgeBaseV2FileStatus.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const KnowledgeBaseV2FileStatus = { + Indexing: "indexing", + Ready: "ready", + Failed: "failed", +} as const; +export type KnowledgeBaseV2FileStatus = (typeof KnowledgeBaseV2FileStatus)[keyof typeof KnowledgeBaseV2FileStatus]; diff --git a/src/api/types/KnowledgeBaseV2WithFiles.ts b/src/api/types/KnowledgeBaseV2WithFiles.ts new file mode 100644 index 00000000..6ba88c5e --- /dev/null +++ b/src/api/types/KnowledgeBaseV2WithFiles.ts @@ -0,0 +1,15 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface KnowledgeBaseV2WithFiles { + name: string; + description?: (string | null) | undefined; + id: string; + orgId: string; + createdAt: string; + updatedAt: string; + files: Vapi.KnowledgeBaseV2File[]; + /** Id of the tool that searches this knowledge base (at most one per base; provisioned on creation). Attach it to an assistant via model.toolIds. Null when the base has no search tool yet. */ + toolId: string | null; +} diff --git a/src/api/types/LangfuseObservabilityPlan.ts b/src/api/types/LangfuseObservabilityPlan.ts index e77f2a33..76d8e6b3 100644 --- a/src/api/types/LangfuseObservabilityPlan.ts +++ b/src/api/types/LangfuseObservabilityPlan.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, and metadata. + */ export interface LangfuseObservabilityPlan { + /** Routes assistant call observability data to Langfuse. */ provider: Vapi.LangfuseObservabilityPlanProvider; /** The name of a Langfuse prompt to link generations to. This enables tracking which prompt version was used for each generation. https://langfuse.com/docs/prompt-management/features/link-to-traces */ promptName?: string | undefined; diff --git a/src/api/types/LangfuseObservabilityPlanProvider.ts b/src/api/types/LangfuseObservabilityPlanProvider.ts index c91acc30..67b2c7aa 100644 --- a/src/api/types/LangfuseObservabilityPlanProvider.ts +++ b/src/api/types/LangfuseObservabilityPlanProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Routes assistant call observability data to Langfuse. */ export const LangfuseObservabilityPlanProvider = { Langfuse: "langfuse", } as const; diff --git a/src/api/types/LegacyAssistantVersion.ts b/src/api/types/LegacyAssistantVersion.ts new file mode 100644 index 00000000..e6980375 --- /dev/null +++ b/src/api/types/LegacyAssistantVersion.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface LegacyAssistantVersion { + id: string; + assistantId: string; + orgId: string; + data?: string | undefined; + createdAt: string; +} diff --git a/src/api/types/LegacyAssistantVersionPaginatedResponse.ts b/src/api/types/LegacyAssistantVersionPaginatedResponse.ts new file mode 100644 index 00000000..6c258fa4 --- /dev/null +++ b/src/api/types/LegacyAssistantVersionPaginatedResponse.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface LegacyAssistantVersionPaginatedResponse { + results: Vapi.LegacyAssistantVersion[]; + metadata: Vapi.PaginationMeta; + nextPageState?: string | undefined; +} diff --git a/src/api/types/LineInsight.ts b/src/api/types/LineInsight.ts index 848d6219..49a0b49a 100644 --- a/src/api/types/LineInsight.ts +++ b/src/api/types/LineInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ export interface LineInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface LineInsight { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. @@ -42,4 +46,6 @@ export interface LineInsight { createdAt: string; /** This is the ISO 8601 date-time string of when the Insight was last updated. */ updatedAt: string; + /** Stable server-owned identifier for system-created insights. */ + systemKey?: string | undefined; } diff --git a/src/api/types/LineInsightMetadata.ts b/src/api/types/LineInsightMetadata.ts index 6d2a9328..89bb12ca 100644 --- a/src/api/types/LineInsightMetadata.ts +++ b/src/api/types/LineInsightMetadata.ts @@ -1,9 +1,17 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds. + */ export interface LineInsightMetadata { + /** Label displayed on the chart's x-axis. */ xAxisLabel?: string | undefined; + /** Label displayed on the chart's y-axis. */ yAxisLabel?: string | undefined; + /** Minimum value displayed on the chart's y-axis. */ yAxisMin?: number | undefined; + /** Maximum value displayed on the chart's y-axis. */ yAxisMax?: number | undefined; + /** Display name for the insight chart. */ name?: string | undefined; } diff --git a/src/api/types/LiquidCondition.ts b/src/api/types/LiquidCondition.ts index e4abd6ec..9bf2a2e1 100644 --- a/src/api/types/LiquidCondition.ts +++ b/src/api/types/LiquidCondition.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Evaluates a Liquid template that must return `true` or `false`. + */ export interface LiquidCondition { /** * This is the Liquid template that must return exactly "true" or "false" as a string. diff --git a/src/api/types/LivekitSmartEndpointingPlan.ts b/src/api/types/LivekitSmartEndpointingPlan.ts index 16edcfa1..cd20d297 100644 --- a/src/api/types/LivekitSmartEndpointingPlan.ts +++ b/src/api/types/LivekitSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior. + */ export interface LivekitSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. */ provider: Vapi.LivekitSmartEndpointingPlanProvider; diff --git a/src/api/types/LmntVoice.ts b/src/api/types/LmntVoice.ts index b75400db..b638c26c 100644 --- a/src/api/types/LmntVoice.ts +++ b/src/api/types/LmntVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, caching, and fallback settings. + */ export interface LmntVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/MakeTool.ts b/src/api/types/MakeTool.ts index fd5fac49..df49247e 100644 --- a/src/api/types/MakeTool.ts +++ b/src/api/types/MakeTool.ts @@ -3,11 +3,8 @@ import type * as Vapi from "../index.js"; export interface MakeTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.MakeToolMessagesItem[] | undefined; /** The type of tool. "make" for Make tool. */ type: Vapi.MakeToolType; diff --git a/src/api/types/MakeToolWithToolCall.ts b/src/api/types/MakeToolWithToolCall.ts index 9a7e5cd5..8a414edc 100644 --- a/src/api/types/MakeToolWithToolCall.ts +++ b/src/api/types/MakeToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface MakeToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.MakeToolWithToolCallMessagesItem[] | undefined; toolCall: Vapi.ToolCall; metadata: Vapi.MakeToolMetadata; diff --git a/src/api/types/McpTool.ts b/src/api/types/McpTool.ts index 11837ca2..b4405281 100644 --- a/src/api/types/McpTool.ts +++ b/src/api/types/McpTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ export interface McpTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.McpToolMessagesItem[] | undefined; /** * This is the server where a `tool-calls` webhook will be sent. @@ -111,5 +111,6 @@ export interface McpTool { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; } diff --git a/src/api/types/McpToolMessages.ts b/src/api/types/McpToolMessages.ts index 9d4c5be8..2fe8b0b6 100644 --- a/src/api/types/McpToolMessages.ts +++ b/src/api/types/McpToolMessages.ts @@ -2,9 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * Per-tool message overrides for a tool discovered through an MCP server. + */ export interface McpToolMessages { /** The name of the tool from the MCP server. */ name: string; - /** Custom messages for this specific tool. Set to an empty array to suppress all messages for this tool. If not provided, the tool will use the default messages from the parent MCP tool configuration. */ + /** Custom messages for this specific tool. Set to an empty array to suppress all messages for this tool. If not provided, the tool will use the default messages from the parent MCP tool configuration. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.McpToolMessagesMessagesItem[] | undefined; } diff --git a/src/api/types/McpToolMetadata.ts b/src/api/types/McpToolMetadata.ts index c43e0fdc..6f9c1b08 100644 --- a/src/api/types/McpToolMetadata.ts +++ b/src/api/types/McpToolMetadata.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Protocol metadata used to communicate with an MCP server. + */ export interface McpToolMetadata { /** This is the protocol used for MCP communication. Defaults to Streamable HTTP. */ protocol?: Vapi.McpToolMetadataProtocol | undefined; diff --git a/src/api/types/MessageAddHookAction.ts b/src/api/types/MessageAddHookAction.ts index 59c5e278..12618768 100644 --- a/src/api/types/MessageAddHookAction.ts +++ b/src/api/types/MessageAddHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response. + */ export interface MessageAddHookAction { /** The message to add to the conversation in OpenAI format */ message: Vapi.OpenAiMessage; diff --git a/src/api/types/MessageTarget.ts b/src/api/types/MessageTarget.ts index efd696f2..ad016769 100644 --- a/src/api/types/MessageTarget.ts +++ b/src/api/types/MessageTarget.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects a conversation message by participant role and position for condition evaluation. + */ export interface MessageTarget { /** * This is the role of the message to target. diff --git a/src/api/types/TrieveCredential.ts b/src/api/types/MicrosoftCredential.ts similarity index 73% rename from src/api/types/TrieveCredential.ts rename to src/api/types/MicrosoftCredential.ts index 6f50acb6..d0625ee0 100644 --- a/src/api/types/TrieveCredential.ts +++ b/src/api/types/MicrosoftCredential.ts @@ -2,10 +2,12 @@ import type * as Vapi from "../index.js"; -export interface TrieveCredential { - provider: Vapi.TrieveCredentialProvider; +export interface MicrosoftCredential { + provider: Vapi.MicrosoftCredentialProvider; /** This is not returned in the API. */ apiKey: string; + /** Azure region for the Speech resource. Defaults to `eastus` when omitted. MAI-Voice-2 is preview and region-limited. */ + region?: string | undefined; /** This is the unique identifier for the credential. */ id: string; /** This is the unique identifier for the org that this credential belongs to. */ diff --git a/src/api/types/MicrosoftCredentialProvider.ts b/src/api/types/MicrosoftCredentialProvider.ts new file mode 100644 index 00000000..bb2eda7d --- /dev/null +++ b/src/api/types/MicrosoftCredentialProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const MicrosoftCredentialProvider = { + Microsoft: "microsoft", +} as const; +export type MicrosoftCredentialProvider = + (typeof MicrosoftCredentialProvider)[keyof typeof MicrosoftCredentialProvider]; diff --git a/src/api/types/MicrosoftVoice.ts b/src/api/types/MicrosoftVoice.ts new file mode 100644 index 00000000..9c70432e --- /dev/null +++ b/src/api/types/MicrosoftVoice.ts @@ -0,0 +1,22 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface MicrosoftVoice { + /** This is the flag to toggle voice caching for the assistant. */ + cachingEnabled?: boolean | undefined; + /** MAI-Voice-2 voice ID. Built-in voices listed in enum. */ + voiceId: Vapi.MicrosoftVoiceVoiceId; + /** Speaking style applied via mstts:express-as on every request. Unknown styles are ignored by Azure and fall back to neutral. */ + style?: Vapi.MicrosoftVoiceStyle | undefined; + /** Style intensity (0.01–2). Default 1 = the predefined style strength. Only applies when `style` is set. */ + styleDegree?: number | undefined; + /** Role-play (age/gender imitation). Requires `style` to be set; ignored otherwise. */ + role?: Vapi.MicrosoftVoiceRole | undefined; + /** This is the plan for chunking the model output before it is sent to the voice provider. */ + chunkPlan?: Vapi.ChunkPlan | undefined; + /** This is the speed multiplier that will be used. */ + speed?: number | undefined; + /** This is the plan for voice provider fallbacks in the event that the primary voice provider fails. */ + fallbackPlan?: Vapi.FallbackPlan | undefined; +} diff --git a/src/api/types/MicrosoftVoiceRole.ts b/src/api/types/MicrosoftVoiceRole.ts new file mode 100644 index 00000000..41d544c5 --- /dev/null +++ b/src/api/types/MicrosoftVoiceRole.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Role-play (age/gender imitation). Requires `style` to be set; ignored otherwise. */ +export const MicrosoftVoiceRole = { + Girl: "Girl", + Boy: "Boy", + YoungAdultFemale: "YoungAdultFemale", + YoungAdultMale: "YoungAdultMale", + OlderAdultFemale: "OlderAdultFemale", + OlderAdultMale: "OlderAdultMale", + SeniorFemale: "SeniorFemale", + SeniorMale: "SeniorMale", +} as const; +export type MicrosoftVoiceRole = (typeof MicrosoftVoiceRole)[keyof typeof MicrosoftVoiceRole]; diff --git a/src/api/types/MicrosoftVoiceStyle.ts b/src/api/types/MicrosoftVoiceStyle.ts new file mode 100644 index 00000000..83b9fc74 --- /dev/null +++ b/src/api/types/MicrosoftVoiceStyle.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Speaking style applied via mstts:express-as on every request. Unknown styles are ignored by Azure and fall back to neutral. */ +export const MicrosoftVoiceStyle = { + Adventurous: "adventurous", + Angry: "angry", + Caring: "caring", + Cheerful: "cheerful", + Confused: "confused", + Curious: "curious", + Determined: "determined", + Disappointed: "disappointed", + Disgusted: "disgusted", + Embarrassed: "embarrassed", + Empathy: "empathy", + Encouraging: "encouraging", + Excited: "excited", + Fearful: "fearful", + Friendly: "friendly", + Happy: "happy", + Hopeful: "hopeful", + Jealous: "jealous", + Joyful: "joyful", + Nostalgic: "nostalgic", + Reflective: "reflective", + Regretful: "regretful", + Relieved: "relieved", + Sad: "sad", + Serious: "serious", + Shouting: "shouting", + Softvoice: "softvoice", + Surprised: "surprised", + Whispering: "whispering", +} as const; +export type MicrosoftVoiceStyle = (typeof MicrosoftVoiceStyle)[keyof typeof MicrosoftVoiceStyle]; diff --git a/src/api/types/MicrosoftVoiceVoiceId.ts b/src/api/types/MicrosoftVoiceVoiceId.ts new file mode 100644 index 00000000..4c5f063f --- /dev/null +++ b/src/api/types/MicrosoftVoiceVoiceId.ts @@ -0,0 +1,52 @@ +// This file was auto-generated by Fern from our API Definition. + +/** MAI-Voice-2 voice ID. Built-in voices listed in enum. */ +export const MicrosoftVoiceVoiceId = { + DeDeKlausMaiVoice2: "de-DE-Klaus:MAI-Voice-2", + DeDeMiaMaiVoice2: "de-DE-Mia:MAI-Voice-2", + EnAuLisaMaiVoice2: "en-AU-Lisa:MAI-Voice-2", + EnUsEthanMaiVoice2: "en-US-Ethan:MAI-Voice-2", + EnUsGrantMaiVoice2: "en-US-Grant:MAI-Voice-2", + EnUsHarperMaiVoice2: "en-US-Harper:MAI-Voice-2", + EnUsIrisMaiVoice2: "en-US-Iris:MAI-Voice-2", + EnUsJasperMaiVoice2: "en-US-Jasper:MAI-Voice-2", + EnUsOliviaMaiVoice2: "en-US-Olivia:MAI-Voice-2", + EsEsMartaMaiVoice2: "es-ES-Marta:MAI-Voice-2", + EsMxAlejoMaiVoice2: "es-MX-Alejo:MAI-Voice-2", + EsMxValeriaMaiVoice2: "es-MX-Valeria:MAI-Voice-2", + FrFrMarcMaiVoice2: "fr-FR-Marc:MAI-Voice-2", + FrFrSoleilMaiVoice2: "fr-FR-Soleil:MAI-Voice-2", + HiInArjunMaiVoice2: "hi-IN-Arjun:MAI-Voice-2", + HiInDhruvMaiVoice2: "hi-IN-Dhruv:MAI-Voice-2", + HiInKavyaMaiVoice2: "hi-IN-Kavya:MAI-Voice-2", + HiInPriyaMaiVoice2: "hi-IN-Priya:MAI-Voice-2", + HuHuBenceMaiVoice2: "hu-HU-Bence:MAI-Voice-2", + HuHuLeventeMaiVoice2: "hu-HU-Levente:MAI-Voice-2", + HuHuLillaMaiVoice2: "hu-HU-Lilla:MAI-Voice-2", + HuHuRekaMaiVoice2: "hu-HU-R\u00E9ka:MAI-Voice-2", + ItItLucaMaiVoice2: "it-IT-Luca:MAI-Voice-2", + ItItRosaMaiVoice2: "it-IT-Rosa:MAI-Voice-2", + KoKrHanaMaiVoice2: "ko-KR-Hana:MAI-Voice-2", + KoKrJunhoMaiVoice2: "ko-KR-Junho:MAI-Voice-2", + NlNlFleurMaiVoice2: "nl-NL-Fleur:MAI-Voice-2", + NlNlSanderMaiVoice2: "nl-NL-Sander:MAI-Voice-2", + PtBrCaioMaiVoice2: "pt-BR-Caio:MAI-Voice-2", + PtBrLuanaMaiVoice2: "pt-BR-Luana:MAI-Voice-2", + PtBrPedroMaiVoice2: "pt-BR-Pedro:MAI-Voice-2", + PtBrRafaelMaiVoice2: "pt-BR-Rafael:MAI-Voice-2", + PtPtRuiMaiVoice2: "pt-PT-Rui:MAI-Voice-2", + RoRoAndreiMaiVoice2: "ro-RO-Andrei:MAI-Voice-2", + RoRoElenaMaiVoice2: "ro-RO-Elena:MAI-Voice-2", + RoRoIoanaMaiVoice2: "ro-RO-Ioana:MAI-Voice-2", + RoRoRaduMaiVoice2: "ro-RO-Radu:MAI-Voice-2", + RuRuLevMaiVoice2: "ru-RU-Lev:MAI-Voice-2", + RuRuMashaMaiVoice2: "ru-RU-Masha:MAI-Voice-2", + ThThKritMaiVoice2: "th-TH-Krit:MAI-Voice-2", + ThThNattapongMaiVoice2: "th-TH-Nattapong:MAI-Voice-2", + TrTrAydinMaiVoice2: "tr-TR-Aydin:MAI-Voice-2", + TrTrElifMaiVoice2: "tr-TR-Elif:MAI-Voice-2", + ZhCnBoMaiVoice2: "zh-CN-Bo:MAI-Voice-2", + ZhCnLanMaiVoice2: "zh-CN-Lan:MAI-Voice-2", + ZhCnMeiMaiVoice2: "zh-CN-Mei:MAI-Voice-2", +} as const; +export type MicrosoftVoiceVoiceId = (typeof MicrosoftVoiceVoiceId)[keyof typeof MicrosoftVoiceVoiceId]; diff --git a/src/api/types/MinCallDurationCondition.ts b/src/api/types/MinCallDurationCondition.ts new file mode 100644 index 00000000..659325a7 --- /dev/null +++ b/src/api/types/MinCallDurationCondition.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface MinCallDurationCondition { + /** + * This is the minimum call duration in seconds required for the structured + * output to run. + * + * When timestamps are unavailable (for example, chat sessions have no call + * timestamps), this check passes and does not block the structured output. + */ + seconds: number; +} diff --git a/src/api/types/MinMessagesCondition.ts b/src/api/types/MinMessagesCondition.ts new file mode 100644 index 00000000..b6854d60 --- /dev/null +++ b/src/api/types/MinMessagesCondition.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface MinMessagesCondition { + /** + * This is the minimum number of conversation messages required for the + * structured output to run. + * + * A count of 0 removes the runtime default minimum, so the structured output + * runs regardless of how few messages the conversation has. + */ + count: number; +} diff --git a/src/api/types/MinimaxLlmModel.ts b/src/api/types/MinimaxLlmModel.ts index b4359102..1debcd36 100644 --- a/src/api/types/MinimaxLlmModel.ts +++ b/src/api/types/MinimaxLlmModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface MinimaxLlmModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface MinimaxLlmModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.MinimaxLlmModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/MinimaxLlmModelToolsItem.ts b/src/api/types/MinimaxLlmModelToolsItem.ts index b9732539..319ff06e 100644 --- a/src/api/types/MinimaxLlmModelToolsItem.ts +++ b/src/api/types/MinimaxLlmModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace MinimaxLlmModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.MinimaxLlmModelToolsItem.ApiRequest + | Vapi.MinimaxLlmModelToolsItem.Bash + | Vapi.MinimaxLlmModelToolsItem.Code + | Vapi.MinimaxLlmModelToolsItem.Computer + | Vapi.MinimaxLlmModelToolsItem.Dtmf + | Vapi.MinimaxLlmModelToolsItem.EndCall + | Vapi.MinimaxLlmModelToolsItem.Function + | Vapi.MinimaxLlmModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.MinimaxLlmModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.MinimaxLlmModelToolsItem.GohighlevelContactCreate + | Vapi.MinimaxLlmModelToolsItem.GohighlevelContactGet + | Vapi.MinimaxLlmModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.MinimaxLlmModelToolsItem.GoogleCalendarEventCreate + | Vapi.MinimaxLlmModelToolsItem.GoogleSheetsRowAppend + | Vapi.MinimaxLlmModelToolsItem.Handoff + | Vapi.MinimaxLlmModelToolsItem.Mcp + | Vapi.MinimaxLlmModelToolsItem.Query + | Vapi.MinimaxLlmModelToolsItem.SlackMessageSend + | Vapi.MinimaxLlmModelToolsItem.Sms + | Vapi.MinimaxLlmModelToolsItem.TextEditor + | Vapi.MinimaxLlmModelToolsItem.TransferCall + | Vapi.MinimaxLlmModelToolsItem.SipRequest + | Vapi.MinimaxLlmModelToolsItem.Voicemail; } diff --git a/src/api/types/MinimaxVoice.ts b/src/api/types/MinimaxVoice.ts index 8c778b89..a6f7bddb 100644 --- a/src/api/types/MinimaxVoice.ts +++ b/src/api/types/MinimaxVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with MiniMax, including voice and model selection, emotion, pitch, speed, volume, region, language, text normalization, chunking, caching, and fallback settings. + */ export interface MinimaxVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/ModelCost.ts b/src/api/types/ModelCost.ts index edddb80f..b0c086a3 100644 --- a/src/api/types/ModelCost.ts +++ b/src/api/types/ModelCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Language-model cost for a call, including model, token usage, and amount. + */ export interface ModelCost { /** * This is the model that was used during the call. @@ -19,6 +22,12 @@ export interface ModelCost { completionTokens: number; /** This is the number of cached prompt tokens used in the call. This is only applicable to certain providers (e.g., OpenAI, Azure OpenAI) that support prompt caching. Cached tokens are billed at a discounted rate. */ cachedPromptTokens?: number | undefined; + /** + * This is the number of reasoning tokens generated in the call. This is only applicable to reasoning models (e.g., OpenAI o-series, GPT-5) on providers that report them. + * + * This is a **subset of `completionTokens`**, not an addition to it: reasoning tokens are already counted in `completionTokens` and are already billed at the output-token rate. It is reported separately for visibility only and does not affect `cost`. + */ + reasoningTokens?: number | undefined; /** This is the cost of the component in USD. */ cost: number; } diff --git a/src/api/types/Monitor.ts b/src/api/types/Monitor.ts index 457935c0..766b8cbe 100644 --- a/src/api/types/Monitor.ts +++ b/src/api/types/Monitor.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Live monitoring data for a call, including attached monitor results and listening and control URLs. + */ export interface Monitor { + /** Results produced by monitors attached to the call. */ monitors?: Vapi.MonitorResult[] | undefined; /** This is the URL where the assistant's calls can be listened to in real-time. To enable, set `assistant.monitorPlan.listenEnabled` to `true`. */ listenUrl?: string | undefined; diff --git a/src/api/types/MonitorPlan.ts b/src/api/types/MonitorPlan.ts index f727b08a..8c4c09c5 100644 --- a/src/api/types/MonitorPlan.ts +++ b/src/api/types/MonitorPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and attached monitors. + */ export interface MonitorPlan { /** * This determines whether the assistant's calls allow live listening. Defaults to true. @@ -35,12 +38,6 @@ export interface MonitorPlan { * @default false */ controlAuthenticationEnabled?: boolean | undefined; - /** - * This the set of monitor ids that are attached to the assistant. - * The source of truth for the monitor ids is the assistant_monitor join table. - * This field can be used for transient assistants and to update assistants with new monitor ids. - * - * @default [] - */ + /** IDs of the monitors attached to the assistant. Use this field for transient assistants or to update the monitors attached to an existing assistant. Defaults to an empty array. */ monitorIds?: string[] | undefined; } diff --git a/src/api/types/MonitorResult.ts b/src/api/types/MonitorResult.ts index 0f41afff..485357db 100644 --- a/src/api/types/MonitorResult.ts +++ b/src/api/types/MonitorResult.ts @@ -1,6 +1,11 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Result of evaluating an attached monitor's filter for a call. + */ export interface MonitorResult { + /** Unique identifier of the monitor that produced this result. */ monitorId: string; + /** Whether the monitor's filter matched the call. */ filterPassed: boolean; } diff --git a/src/api/types/Mono.ts b/src/api/types/Mono.ts index 68a1ef15..39c8d482 100644 --- a/src/api/types/Mono.ts +++ b/src/api/types/Mono.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Mono recording URLs for the combined call and isolated assistant and customer audio. + */ export interface Mono { /** This is the combined recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ combinedUrl?: string | undefined; diff --git a/src/api/types/NeuphonicVoice.ts b/src/api/types/NeuphonicVoice.ts index 6e699ddf..4f05813e 100644 --- a/src/api/types/NeuphonicVoice.ts +++ b/src/api/types/NeuphonicVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, caching, and fallback settings. + */ export interface NeuphonicVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/NodeArtifact.ts b/src/api/types/NodeArtifact.ts index 7788f476..183d8c85 100644 --- a/src/api/types/NodeArtifact.ts +++ b/src/api/types/NodeArtifact.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Messages and variable values captured while a workflow node was active. + */ export interface NodeArtifact { /** These are the messages that were spoken during the node. */ messages?: Vapi.NodeArtifactMessagesItem[] | undefined; diff --git a/src/api/types/NumberComparatorScorecardMetricCondition.ts b/src/api/types/NumberComparatorScorecardMetricCondition.ts new file mode 100644 index 00000000..519f4d69 --- /dev/null +++ b/src/api/types/NumberComparatorScorecardMetricCondition.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface NumberComparatorScorecardMetricCondition { + /** This is the type of the condition. Currently only 'comparator' is supported. */ + type: Vapi.NumberComparatorScorecardMetricConditionType; + /** + * This is the comparator that will be used to compare the result of the structured output with the value specified. + * Only '=', '!=', '>', '<', '>=', and '<=' are supported for number conditions + * Only '=' is supported for boolean conditions. + */ + comparator: Vapi.NumberComparatorScorecardMetricConditionComparator; + /** + * This is the value that will be used to compare the result of the structured output with the comparator. + * If the result of the comparison is true, the points will be added to the overall score. + */ + value: number; + /** + * These are the points that will be added to the overall score if the condition is met. + * The points must be between 0 and 100. + */ + points: number; +} diff --git a/src/api/types/NumberComparatorScorecardMetricConditionComparator.ts b/src/api/types/NumberComparatorScorecardMetricConditionComparator.ts new file mode 100644 index 00000000..e1cb823a --- /dev/null +++ b/src/api/types/NumberComparatorScorecardMetricConditionComparator.ts @@ -0,0 +1,17 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the comparator that will be used to compare the result of the structured output with the value specified. + * Only '=', '!=', '>', '<', '>=', and '<=' are supported for number conditions + * Only '=' is supported for boolean conditions. + */ +export const NumberComparatorScorecardMetricConditionComparator = { + EqualTo: "=", + NotEquals: "!=", + GreaterThan: ">", + LessThan: "<", + GreaterThanOrEqualTo: ">=", + LessThanOrEqualTo: "<=", +} as const; +export type NumberComparatorScorecardMetricConditionComparator = + (typeof NumberComparatorScorecardMetricConditionComparator)[keyof typeof NumberComparatorScorecardMetricConditionComparator]; diff --git a/src/api/types/NumberComparatorScorecardMetricConditionType.ts b/src/api/types/NumberComparatorScorecardMetricConditionType.ts new file mode 100644 index 00000000..9328311d --- /dev/null +++ b/src/api/types/NumberComparatorScorecardMetricConditionType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the condition. Currently only 'comparator' is supported. */ +export const NumberComparatorScorecardMetricConditionType = { + Comparator: "comparator", +} as const; +export type NumberComparatorScorecardMetricConditionType = + (typeof NumberComparatorScorecardMetricConditionType)[keyof typeof NumberComparatorScorecardMetricConditionType]; diff --git a/src/api/types/OAuth2AuthenticationPlan.ts b/src/api/types/OAuth2AuthenticationPlan.ts index 54f1b1cf..cab2e47a 100644 --- a/src/api/types/OAuth2AuthenticationPlan.ts +++ b/src/api/types/OAuth2AuthenticationPlan.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests. + */ export interface OAuth2AuthenticationPlan { + /** Selects OAuth 2.0 authentication. */ type: Vapi.OAuth2AuthenticationPlanType; /** This is the OAuth2 URL. */ url: string; diff --git a/src/api/types/OAuth2AuthenticationPlanType.ts b/src/api/types/OAuth2AuthenticationPlanType.ts index 00741965..e20d34de 100644 --- a/src/api/types/OAuth2AuthenticationPlanType.ts +++ b/src/api/types/OAuth2AuthenticationPlanType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects OAuth 2.0 authentication. */ export const OAuth2AuthenticationPlanType = { Oauth2: "oauth2", } as const; diff --git a/src/api/types/Oauth2AuthenticationSession.ts b/src/api/types/Oauth2AuthenticationSession.ts index 7b65ef67..b90fe39e 100644 --- a/src/api/types/Oauth2AuthenticationSession.ts +++ b/src/api/types/Oauth2AuthenticationSession.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * OAuth 2.0 session tokens and expiration used to authenticate integration requests. + */ export interface Oauth2AuthenticationSession { /** This is the OAuth2 access token. */ accessToken?: string | undefined; diff --git a/src/api/types/OpenAiFunction.ts b/src/api/types/OpenAiFunction.ts index 176c33d1..da69f488 100644 --- a/src/api/types/OpenAiFunction.ts +++ b/src/api/types/OpenAiFunction.ts @@ -2,19 +2,22 @@ import type * as Vapi from "../index.js"; +/** + * Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema behavior. + */ export interface OpenAiFunction { - /** - * This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/). - * - * @default false - */ - strict?: boolean | undefined; /** * This is the the name of the function to be called. * * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. */ name: string; + /** + * This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/). + * + * @default false + */ + strict?: boolean | undefined; /** This is the description of what the function does, used by the AI to choose when and how to call the function. */ description?: string | undefined; /** diff --git a/src/api/types/OpenAiFunctionParameters.ts b/src/api/types/OpenAiFunctionParameters.ts index 2a036bc7..b0058485 100644 --- a/src/api/types/OpenAiFunctionParameters.ts +++ b/src/api/types/OpenAiFunctionParameters.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * JSON object schema defining the properties accepted by a function and which properties are required. + */ export interface OpenAiFunctionParameters { /** This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties. */ type: Vapi.OpenAiFunctionParametersType; diff --git a/src/api/types/OpenAiMessage.ts b/src/api/types/OpenAiMessage.ts index 6183a777..c6e2f524 100644 --- a/src/api/types/OpenAiMessage.ts +++ b/src/api/types/OpenAiMessage.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A conversation message represented in OpenAI chat format. + */ export interface OpenAiMessage { + /** Content of the conversation message. */ content: string | null; + /** Role associated with the conversation message. */ role: Vapi.OpenAiMessageRole; } diff --git a/src/api/types/OpenAiMessageRole.ts b/src/api/types/OpenAiMessageRole.ts index a5b26da8..d4fdae0b 100644 --- a/src/api/types/OpenAiMessageRole.ts +++ b/src/api/types/OpenAiMessageRole.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Role associated with the conversation message. */ export const OpenAiMessageRole = { Assistant: "assistant", Function: "function", diff --git a/src/api/types/OpenAiModel.ts b/src/api/types/OpenAiModel.ts index e53272ac..ba4541a1 100644 --- a/src/api/types/OpenAiModel.ts +++ b/src/api/types/OpenAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, tools, prompt caching, and generation settings. + */ export interface OpenAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,6 +20,13 @@ export interface OpenAiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** @@ -45,7 +55,7 @@ export interface OpenAiModel { * - `in_memory`: Default behavior, cache retained in GPU memory only * - `24h`: Extended caching, keeps cached prefixes active for up to 24 hours by offloading to GPU-local storage * - * Only applies to models: gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gpt-5.2, gpt-5.1, gpt-5.1-codex, gpt-5.1-codex-mini, gpt-5.1-chat-latest, gpt-5, gpt-5-codex, gpt-4.1 + * Only applies to models: gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-5.5, chat-latest, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gpt-5.2, gpt-5.1, gpt-5.1-codex, gpt-5.1-codex-mini, gpt-5.1-chat-latest, gpt-5, gpt-5-codex, gpt-4.1 * * @default undefined (uses API default which is 'in_memory') */ @@ -58,7 +68,14 @@ export interface OpenAiModel { * @default undefined */ promptCacheKey?: string | undefined; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** + * Reasoning effort for reasoning-capable OpenAI models. + * For `gpt-realtime-2`: forwarded to V2 stream's session.update as `reasoning.effort`. + * For non-realtime OpenAI models, model-aware validation limits newly public + * values while preserving the existing four-value storage contract. + */ + reasoningEffort?: Vapi.OpenAiModelReasoningEffort | undefined; + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/OpenAiModelFallbackModelsItem.ts b/src/api/types/OpenAiModelFallbackModelsItem.ts index b9ff4dc8..ace83bb6 100644 --- a/src/api/types/OpenAiModelFallbackModelsItem.ts +++ b/src/api/types/OpenAiModelFallbackModelsItem.ts @@ -1,6 +1,11 @@ // This file was auto-generated by Fern from our API Definition. export const OpenAiModelFallbackModelsItem = { + Gpt56Sol: "gpt-5.6-sol", + Gpt56Terra: "gpt-5.6-terra", + Gpt56Luna: "gpt-5.6-luna", + Gpt55: "gpt-5.5", + ChatLatest: "chat-latest", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -29,6 +34,7 @@ export const OpenAiModelFallbackModelsItem = { Gpt4OMiniRealtimePreview20241217: "gpt-4o-mini-realtime-preview-2024-12-17", GptRealtime20250828: "gpt-realtime-2025-08-28", GptRealtimeMini20251215: "gpt-realtime-mini-2025-12-15", + GptRealtime2: "gpt-realtime-2", Gpt4OMini20240718: "gpt-4o-mini-2024-07-18", Gpt4OMini: "gpt-4o-mini", Gpt4O: "gpt-4o", @@ -47,6 +53,35 @@ export const OpenAiModelFallbackModelsItem = { Gpt35Turbo1106: "gpt-3.5-turbo-1106", Gpt35Turbo16K: "gpt-3.5-turbo-16k", Gpt35Turbo0613: "gpt-3.5-turbo-0613", + Gpt56LunaWestus3: "gpt-5.6-luna:westus3", + Gpt56TerraWestus3: "gpt-5.6-terra:westus3", + Gpt56SolWestus3: "gpt-5.6-sol:westus3", + Gpt54Eastus2: "gpt-5.4:eastus2", + Gpt54Swedencentral: "gpt-5.4:swedencentral", + Gpt54MiniEastus2: "gpt-5.4-mini:eastus2", + Gpt54MiniSwedencentral: "gpt-5.4-mini:swedencentral", + Gpt54NanoEastus2: "gpt-5.4-nano:eastus2", + Gpt54NanoSwedencentral: "gpt-5.4-nano:swedencentral", + Gpt52Eastus2: "gpt-5.2:eastus2", + Gpt52Swedencentral: "gpt-5.2:swedencentral", + Gpt51Eastus2: "gpt-5.1:eastus2", + Gpt51Swedencentral: "gpt-5.1:swedencentral", + Gpt5Eastus2: "gpt-5:eastus2", + Gpt5Swedencentral: "gpt-5:swedencentral", + Gpt5Canadaeast: "gpt-5:canadaeast", + Gpt5Eastus: "gpt-5:eastus", + Gpt5Westeurope: "gpt-5:westeurope", + Gpt5Germanywestcentral: "gpt-5:germanywestcentral", + Gpt5Polandcentral: "gpt-5:polandcentral", + Gpt5Spaincentral: "gpt-5:spaincentral", + Gpt5MiniEastus2: "gpt-5-mini:eastus2", + Gpt5MiniSwedencentral: "gpt-5-mini:swedencentral", + Gpt5MiniWesteurope: "gpt-5-mini:westeurope", + Gpt5MiniGermanywestcentral: "gpt-5-mini:germanywestcentral", + Gpt5MiniPolandcentral: "gpt-5-mini:polandcentral", + Gpt5MiniSpaincentral: "gpt-5-mini:spaincentral", + Gpt5NanoEastus2: "gpt-5-nano:eastus2", + Gpt5NanoSwedencentral: "gpt-5-nano:swedencentral", Gpt4120250414Westus: "gpt-4.1-2025-04-14:westus", Gpt4120250414Eastus2: "gpt-4.1-2025-04-14:eastus2", Gpt4120250414Eastus: "gpt-4.1-2025-04-14:eastus", @@ -119,6 +154,9 @@ export const OpenAiModelFallbackModelsItem = { Gpt35Turbo0125Southcentralus: "gpt-3.5-turbo-0125:southcentralus", Gpt35Turbo1106Canadaeast: "gpt-3.5-turbo-1106:canadaeast", Gpt35Turbo1106Westus: "gpt-3.5-turbo-1106:westus", + Gpt41Australiaeast: "gpt-4.1:australiaeast", + Gpt4OAustraliaeast: "gpt-4o:australiaeast", + Gpt54MiniAustraliaeast: "gpt-5.4-mini:australiaeast", } as const; export type OpenAiModelFallbackModelsItem = (typeof OpenAiModelFallbackModelsItem)[keyof typeof OpenAiModelFallbackModelsItem]; diff --git a/src/api/types/OpenAiModelModel.ts b/src/api/types/OpenAiModelModel.ts index 6f5c2da4..5fc529b7 100644 --- a/src/api/types/OpenAiModelModel.ts +++ b/src/api/types/OpenAiModelModel.ts @@ -9,6 +9,11 @@ * @default undefined */ export const OpenAiModelModel = { + Gpt56Sol: "gpt-5.6-sol", + Gpt56Terra: "gpt-5.6-terra", + Gpt56Luna: "gpt-5.6-luna", + Gpt55: "gpt-5.5", + ChatLatest: "chat-latest", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -37,6 +42,7 @@ export const OpenAiModelModel = { Gpt4OMiniRealtimePreview20241217: "gpt-4o-mini-realtime-preview-2024-12-17", GptRealtime20250828: "gpt-realtime-2025-08-28", GptRealtimeMini20251215: "gpt-realtime-mini-2025-12-15", + GptRealtime2: "gpt-realtime-2", Gpt4OMini20240718: "gpt-4o-mini-2024-07-18", Gpt4OMini: "gpt-4o-mini", Gpt4O: "gpt-4o", @@ -55,6 +61,35 @@ export const OpenAiModelModel = { Gpt35Turbo1106: "gpt-3.5-turbo-1106", Gpt35Turbo16K: "gpt-3.5-turbo-16k", Gpt35Turbo0613: "gpt-3.5-turbo-0613", + Gpt56LunaWestus3: "gpt-5.6-luna:westus3", + Gpt56TerraWestus3: "gpt-5.6-terra:westus3", + Gpt56SolWestus3: "gpt-5.6-sol:westus3", + Gpt54Eastus2: "gpt-5.4:eastus2", + Gpt54Swedencentral: "gpt-5.4:swedencentral", + Gpt54MiniEastus2: "gpt-5.4-mini:eastus2", + Gpt54MiniSwedencentral: "gpt-5.4-mini:swedencentral", + Gpt54NanoEastus2: "gpt-5.4-nano:eastus2", + Gpt54NanoSwedencentral: "gpt-5.4-nano:swedencentral", + Gpt52Eastus2: "gpt-5.2:eastus2", + Gpt52Swedencentral: "gpt-5.2:swedencentral", + Gpt51Eastus2: "gpt-5.1:eastus2", + Gpt51Swedencentral: "gpt-5.1:swedencentral", + Gpt5Eastus2: "gpt-5:eastus2", + Gpt5Swedencentral: "gpt-5:swedencentral", + Gpt5Canadaeast: "gpt-5:canadaeast", + Gpt5Eastus: "gpt-5:eastus", + Gpt5Westeurope: "gpt-5:westeurope", + Gpt5Germanywestcentral: "gpt-5:germanywestcentral", + Gpt5Polandcentral: "gpt-5:polandcentral", + Gpt5Spaincentral: "gpt-5:spaincentral", + Gpt5MiniEastus2: "gpt-5-mini:eastus2", + Gpt5MiniSwedencentral: "gpt-5-mini:swedencentral", + Gpt5MiniWesteurope: "gpt-5-mini:westeurope", + Gpt5MiniGermanywestcentral: "gpt-5-mini:germanywestcentral", + Gpt5MiniPolandcentral: "gpt-5-mini:polandcentral", + Gpt5MiniSpaincentral: "gpt-5-mini:spaincentral", + Gpt5NanoEastus2: "gpt-5-nano:eastus2", + Gpt5NanoSwedencentral: "gpt-5-nano:swedencentral", Gpt4120250414Westus: "gpt-4.1-2025-04-14:westus", Gpt4120250414Eastus2: "gpt-4.1-2025-04-14:eastus2", Gpt4120250414Eastus: "gpt-4.1-2025-04-14:eastus", @@ -127,5 +162,8 @@ export const OpenAiModelModel = { Gpt35Turbo0125Southcentralus: "gpt-3.5-turbo-0125:southcentralus", Gpt35Turbo1106Canadaeast: "gpt-3.5-turbo-1106:canadaeast", Gpt35Turbo1106Westus: "gpt-3.5-turbo-1106:westus", + Gpt41Australiaeast: "gpt-4.1:australiaeast", + Gpt4OAustraliaeast: "gpt-4o:australiaeast", + Gpt54MiniAustraliaeast: "gpt-5.4-mini:australiaeast", } as const; export type OpenAiModelModel = (typeof OpenAiModelModel)[keyof typeof OpenAiModelModel]; diff --git a/src/api/types/OpenAiModelPromptCacheRetention.ts b/src/api/types/OpenAiModelPromptCacheRetention.ts index 3f6a272e..8369706a 100644 --- a/src/api/types/OpenAiModelPromptCacheRetention.ts +++ b/src/api/types/OpenAiModelPromptCacheRetention.ts @@ -6,7 +6,7 @@ * - `in_memory`: Default behavior, cache retained in GPU memory only * - `24h`: Extended caching, keeps cached prefixes active for up to 24 hours by offloading to GPU-local storage * - * Only applies to models: gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gpt-5.2, gpt-5.1, gpt-5.1-codex, gpt-5.1-codex-mini, gpt-5.1-chat-latest, gpt-5, gpt-5-codex, gpt-4.1 + * Only applies to models: gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, gpt-5.5, chat-latest, gpt-5.4, gpt-5.4-mini, gpt-5.4-nano, gpt-5.2, gpt-5.1, gpt-5.1-codex, gpt-5.1-codex-mini, gpt-5.1-chat-latest, gpt-5, gpt-5-codex, gpt-4.1 * * @default undefined (uses API default which is 'in_memory') */ diff --git a/src/api/types/OpenAiModelReasoningEffort.ts b/src/api/types/OpenAiModelReasoningEffort.ts new file mode 100644 index 00000000..666ec478 --- /dev/null +++ b/src/api/types/OpenAiModelReasoningEffort.ts @@ -0,0 +1,17 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * Reasoning effort for reasoning-capable OpenAI models. + * For `gpt-realtime-2`: forwarded to V2 stream's session.update as `reasoning.effort`. + * For non-realtime OpenAI models, model-aware validation limits newly public + * values while preserving the existing four-value storage contract. + */ +export const OpenAiModelReasoningEffort = { + Minimal: "minimal", + None: "none", + Low: "low", + Medium: "medium", + High: "high", + Xhigh: "xhigh", +} as const; +export type OpenAiModelReasoningEffort = (typeof OpenAiModelReasoningEffort)[keyof typeof OpenAiModelReasoningEffort]; diff --git a/src/api/types/OpenAiModelToolsItem.ts b/src/api/types/OpenAiModelToolsItem.ts index de1f6fb1..3e33116f 100644 --- a/src/api/types/OpenAiModelToolsItem.ts +++ b/src/api/types/OpenAiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace OpenAiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.OpenAiModelToolsItem.ApiRequest + | Vapi.OpenAiModelToolsItem.Bash + | Vapi.OpenAiModelToolsItem.Code + | Vapi.OpenAiModelToolsItem.Computer + | Vapi.OpenAiModelToolsItem.Dtmf + | Vapi.OpenAiModelToolsItem.EndCall + | Vapi.OpenAiModelToolsItem.Function + | Vapi.OpenAiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.OpenAiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.OpenAiModelToolsItem.GohighlevelContactCreate + | Vapi.OpenAiModelToolsItem.GohighlevelContactGet + | Vapi.OpenAiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.OpenAiModelToolsItem.GoogleCalendarEventCreate + | Vapi.OpenAiModelToolsItem.GoogleSheetsRowAppend + | Vapi.OpenAiModelToolsItem.Handoff + | Vapi.OpenAiModelToolsItem.Mcp + | Vapi.OpenAiModelToolsItem.Query + | Vapi.OpenAiModelToolsItem.SlackMessageSend + | Vapi.OpenAiModelToolsItem.Sms + | Vapi.OpenAiModelToolsItem.TextEditor + | Vapi.OpenAiModelToolsItem.TransferCall + | Vapi.OpenAiModelToolsItem.SipRequest + | Vapi.OpenAiModelToolsItem.Voicemail; } diff --git a/src/api/types/OpenAiTranscriber.ts b/src/api/types/OpenAiTranscriber.ts index 257e2070..5e7c8de5 100644 --- a/src/api/types/OpenAiTranscriber.ts +++ b/src/api/types/OpenAiTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and fallback settings. + */ export interface OpenAiTranscriber { /** This is the model that will be used for the transcription. */ model: Vapi.OpenAiTranscriberModel; diff --git a/src/api/types/OpenAiVoice.ts b/src/api/types/OpenAiVoice.ts index 45bf026c..0dfd1422 100644 --- a/src/api/types/OpenAiVoice.ts +++ b/src/api/types/OpenAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, caching, and fallback settings. + */ export interface OpenAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/OpenAiVoicemailDetectionPlan.ts b/src/api/types/OpenAiVoicemailDetectionPlan.ts index a2210187..2fd0336b 100644 --- a/src/api/types/OpenAiVoicemailDetectionPlan.ts +++ b/src/api/types/OpenAiVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff. + */ export interface OpenAiVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/OpenRouterModel.ts b/src/api/types/OpenRouterModel.ts index 861b7c9e..c843e3e3 100644 --- a/src/api/types/OpenRouterModel.ts +++ b/src/api/types/OpenRouterModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, tools, knowledge-base access, and generation settings. + */ export interface OpenRouterModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface OpenRouterModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/OpenRouterModelToolsItem.ts b/src/api/types/OpenRouterModelToolsItem.ts index b51a6b41..f7ff981a 100644 --- a/src/api/types/OpenRouterModelToolsItem.ts +++ b/src/api/types/OpenRouterModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace OpenRouterModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.OpenRouterModelToolsItem.ApiRequest + | Vapi.OpenRouterModelToolsItem.Bash + | Vapi.OpenRouterModelToolsItem.Code + | Vapi.OpenRouterModelToolsItem.Computer + | Vapi.OpenRouterModelToolsItem.Dtmf + | Vapi.OpenRouterModelToolsItem.EndCall + | Vapi.OpenRouterModelToolsItem.Function + | Vapi.OpenRouterModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.OpenRouterModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.OpenRouterModelToolsItem.GohighlevelContactCreate + | Vapi.OpenRouterModelToolsItem.GohighlevelContactGet + | Vapi.OpenRouterModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.OpenRouterModelToolsItem.GoogleCalendarEventCreate + | Vapi.OpenRouterModelToolsItem.GoogleSheetsRowAppend + | Vapi.OpenRouterModelToolsItem.Handoff + | Vapi.OpenRouterModelToolsItem.Mcp + | Vapi.OpenRouterModelToolsItem.Query + | Vapi.OpenRouterModelToolsItem.SlackMessageSend + | Vapi.OpenRouterModelToolsItem.Sms + | Vapi.OpenRouterModelToolsItem.TextEditor + | Vapi.OpenRouterModelToolsItem.TransferCall + | Vapi.OpenRouterModelToolsItem.SipRequest + | Vapi.OpenRouterModelToolsItem.Voicemail; } diff --git a/src/api/types/Org.ts b/src/api/types/Org.ts index 4f34bd22..47d46636 100644 --- a/src/api/types/Org.ts +++ b/src/api/types/Org.ts @@ -9,6 +9,13 @@ export interface Org { * This is due to the compliance requirements of HIPAA. Other providers may not meet these requirements. */ hipaaEnabled?: boolean | undefined; + /** + * The org was created locally, but WorkOS access is still being repaired. + * Clients should keep the current session/org and refresh the org list. + */ + workosRepairPending?: boolean | undefined; + /** Whether the pending WorkOS repair was accepted by Kafka. */ + workosRepairQueued?: boolean | undefined; subscription?: Vapi.Subscription | undefined; /** This is the ID of the subscription the org belongs to. */ subscriptionId?: string | undefined; diff --git a/src/api/types/OutputTool.ts b/src/api/types/OutputTool.ts index 3d95e68b..3741a75f 100644 --- a/src/api/types/OutputTool.ts +++ b/src/api/types/OutputTool.ts @@ -3,11 +3,8 @@ import type * as Vapi from "../index.js"; export interface OutputTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.OutputToolMessagesItem[] | undefined; /** The type of tool. "output" for Output tool. */ type: Vapi.OutputToolType; diff --git a/src/api/types/PaginationMeta.ts b/src/api/types/PaginationMeta.ts index 2eaafb43..72a766f1 100644 --- a/src/api/types/PaginationMeta.ts +++ b/src/api/types/PaginationMeta.ts @@ -1,10 +1,30 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * Pagination and retention metadata returned with a paginated list of phone numbers. + */ export interface PaginationMeta { + /** The number of phone numbers returned per page. */ itemsPerPage: number; + /** The total number of phone numbers matching the request. */ totalItems: number; + /** The current page number. */ currentPage: number; + totalPages?: number | undefined; + hasNextPage?: boolean | undefined; + /** + * Opaque cursor for the next page under keyset pagination (PRO-3163). Pass it + * back as the `cursor` query param to fetch the next page without an OFFSET + * scan. Present only when a further page likely exists. + */ + nextCursor?: string | undefined; + sortOrder?: Vapi.PaginationMetaSortOrder | undefined; + /** Whether additional matching phone numbers exist beyond the organization's data-retention window. */ itemsBeyondRetention?: boolean | undefined; + /** The inclusive upper creation-time boundary applied to the result set. */ createdAtLe?: string | undefined; + /** The inclusive lower creation-time boundary applied to the result set. */ createdAtGe?: string | undefined; } diff --git a/src/api/types/PaginationMetaSortOrder.ts b/src/api/types/PaginationMetaSortOrder.ts new file mode 100644 index 00000000..8660ddca --- /dev/null +++ b/src/api/types/PaginationMetaSortOrder.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const PaginationMetaSortOrder = { + Asc: "ASC", + Desc: "DESC", +} as const; +export type PaginationMetaSortOrder = (typeof PaginationMetaSortOrder)[keyof typeof PaginationMetaSortOrder]; diff --git a/src/api/types/PendingInvitationDto.ts b/src/api/types/PendingInvitationDto.ts new file mode 100644 index 00000000..4d4f0db4 --- /dev/null +++ b/src/api/types/PendingInvitationDto.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface PendingInvitationDto { + id: string; + email: string; +} diff --git a/src/api/types/PendingInvitationsResponseDto.ts b/src/api/types/PendingInvitationsResponseDto.ts new file mode 100644 index 00000000..46a5324b --- /dev/null +++ b/src/api/types/PendingInvitationsResponseDto.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface PendingInvitationsResponseDto { + invitations: Vapi.PendingInvitationDto[]; +} diff --git a/src/api/types/PerformanceMetrics.ts b/src/api/types/PerformanceMetrics.ts index bf9d08a5..618c467f 100644 --- a/src/api/types/PerformanceMetrics.ts +++ b/src/api/types/PerformanceMetrics.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption metrics. + */ export interface PerformanceMetrics { /** These are the individual latencies for each turn. */ turnLatencies?: Vapi.TurnLatency[] | undefined; diff --git a/src/api/types/PerplexityAiModel.ts b/src/api/types/PerplexityAiModel.ts index 35339dc2..c071bc40 100644 --- a/src/api/types/PerplexityAiModel.ts +++ b/src/api/types/PerplexityAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface PerplexityAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface PerplexityAiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/PerplexityAiModelToolsItem.ts b/src/api/types/PerplexityAiModelToolsItem.ts index 98d960c1..642a55b9 100644 --- a/src/api/types/PerplexityAiModelToolsItem.ts +++ b/src/api/types/PerplexityAiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace PerplexityAiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.PerplexityAiModelToolsItem.ApiRequest + | Vapi.PerplexityAiModelToolsItem.Bash + | Vapi.PerplexityAiModelToolsItem.Code + | Vapi.PerplexityAiModelToolsItem.Computer + | Vapi.PerplexityAiModelToolsItem.Dtmf + | Vapi.PerplexityAiModelToolsItem.EndCall + | Vapi.PerplexityAiModelToolsItem.Function + | Vapi.PerplexityAiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.PerplexityAiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.PerplexityAiModelToolsItem.GohighlevelContactCreate + | Vapi.PerplexityAiModelToolsItem.GohighlevelContactGet + | Vapi.PerplexityAiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.PerplexityAiModelToolsItem.GoogleCalendarEventCreate + | Vapi.PerplexityAiModelToolsItem.GoogleSheetsRowAppend + | Vapi.PerplexityAiModelToolsItem.Handoff + | Vapi.PerplexityAiModelToolsItem.Mcp + | Vapi.PerplexityAiModelToolsItem.Query + | Vapi.PerplexityAiModelToolsItem.SlackMessageSend + | Vapi.PerplexityAiModelToolsItem.Sms + | Vapi.PerplexityAiModelToolsItem.TextEditor + | Vapi.PerplexityAiModelToolsItem.TransferCall + | Vapi.PerplexityAiModelToolsItem.SipRequest + | Vapi.PerplexityAiModelToolsItem.Voicemail; } diff --git a/src/api/types/PhoneNumberCallEndingHookFilter.ts b/src/api/types/PhoneNumberCallEndingHookFilter.ts index a993a39f..922ebf13 100644 --- a/src/api/types/PhoneNumberCallEndingHookFilter.ts +++ b/src/api/types/PhoneNumberCallEndingHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs. + */ export interface PhoneNumberCallEndingHookFilter { /** This is the type of filter - currently only "oneOf" is supported */ type: Vapi.PhoneNumberCallEndingHookFilterType; diff --git a/src/api/types/PhoneNumberCallRingingHookFilter.ts b/src/api/types/PhoneNumberCallRingingHookFilter.ts index c6beb9d5..cde446c3 100644 --- a/src/api/types/PhoneNumberCallRingingHookFilter.ts +++ b/src/api/types/PhoneNumberCallRingingHookFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs. + */ export interface PhoneNumberCallRingingHookFilter { /** This is the type of filter - matches when the specified field starts with any of the given prefixes */ type: Vapi.PhoneNumberCallRingingHookFilterType; diff --git a/src/api/types/PhoneNumberHookCallEnding.ts b/src/api/types/PhoneNumberHookCallEnding.ts index efa6cbcf..561219b9 100644 --- a/src/api/types/PhoneNumberHookCallEnding.ts +++ b/src/api/types/PhoneNumberHookCallEnding.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason. + */ export interface PhoneNumberHookCallEnding { /** Optional filters to decide when to trigger - restricted to assistant-request related ended reasons */ filters?: Vapi.PhoneNumberCallEndingHookFilter[] | undefined; diff --git a/src/api/types/PhoneNumberHookCallRinging.ts b/src/api/types/PhoneNumberHookCallRinging.ts index 57c70dba..a1357f59 100644 --- a/src/api/types/PhoneNumberHookCallRinging.ts +++ b/src/api/types/PhoneNumberHookCallRinging.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters match. + */ export interface PhoneNumberHookCallRinging { /** Optional filters to decide when to trigger the hook. Currently supports filtering by caller country code. */ filters?: Vapi.PhoneNumberCallRingingHookFilter[] | undefined; diff --git a/src/api/types/PhoneNumberPaginatedResponse.ts b/src/api/types/PhoneNumberPaginatedResponse.ts index 94d13d64..94056d9a 100644 --- a/src/api/types/PhoneNumberPaginatedResponse.ts +++ b/src/api/types/PhoneNumberPaginatedResponse.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of phone numbers and metadata describing the result set. + */ export interface PhoneNumberPaginatedResponse { /** A list of phone numbers, which can be of any provider type. */ results: Vapi.PhoneNumberPaginatedResponseResultsItem[]; diff --git a/src/api/types/PieInsight.ts b/src/api/types/PieInsight.ts index 95645181..22844bd1 100644 --- a/src/api/types/PieInsight.ts +++ b/src/api/types/PieInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information. + */ export interface PieInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface PieInsight { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. @@ -40,4 +44,6 @@ export interface PieInsight { createdAt: string; /** This is the ISO 8601 date-time string of when the Insight was last updated. */ updatedAt: string; + /** Stable server-owned identifier for system-created insights. */ + systemKey?: string | undefined; } diff --git a/src/api/types/PlayHtVoice.ts b/src/api/types/PlayHtVoice.ts index 04ac51f2..1df72025 100644 --- a/src/api/types/PlayHtVoice.ts +++ b/src/api/types/PlayHtVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, caching, and fallback settings. + */ export interface PlayHtVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/PromptInjectionSecurityFilter.ts b/src/api/types/PromptInjectionSecurityFilter.ts index 8b08c5e7..11a46a35 100644 --- a/src/api/types/PromptInjectionSecurityFilter.ts +++ b/src/api/types/PromptInjectionSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential prompt-injection patterns from transcripts. + */ export interface PromptInjectionSecurityFilter { /** The type of security threat to filter. */ type: Vapi.PromptInjectionSecurityFilterType; diff --git a/src/api/types/ProviderResource.ts b/src/api/types/ProviderResource.ts index adc8f565..11c37334 100644 --- a/src/api/types/ProviderResource.ts +++ b/src/api/types/ProviderResource.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, resource data, and lifecycle information. + */ export interface ProviderResource { /** This is the unique identifier for the provider resource. */ id: string; diff --git a/src/api/types/ProviderResourcePaginatedResponse.ts b/src/api/types/ProviderResourcePaginatedResponse.ts index a2e9165a..7c145fe7 100644 --- a/src/api/types/ProviderResourcePaginatedResponse.ts +++ b/src/api/types/ProviderResourcePaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of provider resources and metadata describing the result set. + */ export interface ProviderResourcePaginatedResponse { + /** The provider resources returned for the current page. */ results: Vapi.ProviderResource[]; + /** Pagination metadata for the provider-resource result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/PublicKeyEncryptionPlan.ts b/src/api/types/PublicKeyEncryptionPlan.ts index 0aace0a6..3fa63cbe 100644 --- a/src/api/types/PublicKeyEncryptionPlan.ts +++ b/src/api/types/PublicKeyEncryptionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for encrypting sensitive outbound request data with a public key. + */ export interface PublicKeyEncryptionPlan { /** The encryption algorithm to use. */ algorithm: Vapi.PublicKeyEncryptionPlanAlgorithm; diff --git a/src/api/types/QueryTool.ts b/src/api/types/QueryTool.ts index e16cd7fe..90cb7a65 100644 --- a/src/api/types/QueryTool.ts +++ b/src/api/types/QueryTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that searches configured knowledge bases and returns relevant content to the assistant. + */ export interface QueryTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.QueryToolMessagesItem[] | undefined; /** The knowledge bases to query */ knowledgeBases?: Vapi.KnowledgeBase[] | undefined; diff --git a/src/api/types/RceSecurityFilter.ts b/src/api/types/RceSecurityFilter.ts index b21970e6..1e475fc7 100644 --- a/src/api/types/RceSecurityFilter.ts +++ b/src/api/types/RceSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential remote code execution (RCE) patterns from transcripts. + */ export interface RceSecurityFilter { /** The type of security threat to filter. */ type: Vapi.RceSecurityFilterType; diff --git a/src/api/types/Recording.ts b/src/api/types/Recording.ts index 853a9ed4..0d346618 100644 --- a/src/api/types/Recording.ts +++ b/src/api/types/Recording.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Call recording locations, including stereo, video, and separated mono recording URLs. + */ export interface Recording { /** This is the stereo recording url for the call. To enable, set `assistant.artifactPlan.recordingEnabled`. */ stereoUrl?: string | undefined; diff --git a/src/api/types/RecordingConsent.ts b/src/api/types/RecordingConsent.ts index 5cabcda6..ac4ef811 100644 --- a/src/api/types/RecordingConsent.ts +++ b/src/api/types/RecordingConsent.ts @@ -1,8 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * Result of the recording-consent flow, including consent type and the time consent was granted. + */ export interface RecordingConsent { /** This is the type of recording consent. */ - type: Record; + type: Vapi.RecordingConsentType; /** * This is the date and time the recording consent was granted. * If not specified, it means the recording consent was not granted. diff --git a/src/api/types/RecordingConsentPlanStayOnLine.ts b/src/api/types/RecordingConsentPlanStayOnLine.ts index 5137786d..20ecaeb2 100644 --- a/src/api/types/RecordingConsentPlanStayOnLine.ts +++ b/src/api/types/RecordingConsentPlanStayOnLine.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requesting recording consent by treating continued presence on the call as consent, including the announcement voice and wait time. + */ export interface RecordingConsentPlanStayOnLine { /** * This is the message asking for consent to record the call. @@ -14,6 +17,20 @@ export interface RecordingConsentPlanStayOnLine { * Use a different voice for the consent message for a better user experience. */ voice?: Vapi.RecordingConsentPlanStayOnLineVoice | undefined; + /** + * This controls whether the consent assistant speaks first or waits for the caller to speak first. + * + * Use: + * - `assistant-speaks-first` (default) to have the consent assistant play the consent message as soon as the call is answered. + * - `assistant-waits-for-user` to have the consent assistant wait for the caller to speak before playing the consent message. + * + * We strongly recommend `assistant-waits-for-user` for outbound calls. Some telephony providers signal "answered" while the line is still ringing, which can cause the consent message to play into a ringing line and be missed by the caller. Waiting for the caller to speak first guarantees they hear the full consent message. + * + * Note: when combined with `type: 'stay-on-line'`, silence only counts toward consent after the caller has spoken at least once. + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.RecordingConsentPlanStayOnLineFirstMessageMode | undefined; /** Number of seconds to wait before transferring to the assistant if user stays on the call */ waitSeconds?: number | undefined; } diff --git a/src/api/types/RecordingConsentPlanStayOnLineFirstMessageMode.ts b/src/api/types/RecordingConsentPlanStayOnLineFirstMessageMode.ts new file mode 100644 index 00000000..3a9baacb --- /dev/null +++ b/src/api/types/RecordingConsentPlanStayOnLineFirstMessageMode.ts @@ -0,0 +1,21 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This controls whether the consent assistant speaks first or waits for the caller to speak first. + * + * Use: + * - `assistant-speaks-first` (default) to have the consent assistant play the consent message as soon as the call is answered. + * - `assistant-waits-for-user` to have the consent assistant wait for the caller to speak before playing the consent message. + * + * We strongly recommend `assistant-waits-for-user` for outbound calls. Some telephony providers signal "answered" while the line is still ringing, which can cause the consent message to play into a ringing line and be missed by the caller. Waiting for the caller to speak first guarantees they hear the full consent message. + * + * Note: when combined with `type: 'stay-on-line'`, silence only counts toward consent after the caller has spoken at least once. + * + * @default 'assistant-speaks-first' + */ +export const RecordingConsentPlanStayOnLineFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type RecordingConsentPlanStayOnLineFirstMessageMode = + (typeof RecordingConsentPlanStayOnLineFirstMessageMode)[keyof typeof RecordingConsentPlanStayOnLineFirstMessageMode]; diff --git a/src/api/types/RecordingConsentPlanStayOnLineVoice.ts b/src/api/types/RecordingConsentPlanStayOnLineVoice.ts index 05601502..d59473fb 100644 --- a/src/api/types/RecordingConsentPlanStayOnLineVoice.ts +++ b/src/api/types/RecordingConsentPlanStayOnLineVoice.ts @@ -24,7 +24,9 @@ export type RecordingConsentPlanStayOnLineVoice = | Vapi.RecordingConsentPlanStayOnLineVoice.Vapi | Vapi.RecordingConsentPlanStayOnLineVoice.Sesame | Vapi.RecordingConsentPlanStayOnLineVoice.Inworld - | Vapi.RecordingConsentPlanStayOnLineVoice.Minimax; + | Vapi.RecordingConsentPlanStayOnLineVoice.Minimax + | Vapi.RecordingConsentPlanStayOnLineVoice.Xai + | Vapi.RecordingConsentPlanStayOnLineVoice.Microsoft; export namespace RecordingConsentPlanStayOnLineVoice { export interface Azure extends Vapi.AzureVoice { @@ -98,4 +100,12 @@ export namespace RecordingConsentPlanStayOnLineVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/RecordingConsentPlanVerbal.ts b/src/api/types/RecordingConsentPlanVerbal.ts index b23459dd..44f8a7aa 100644 --- a/src/api/types/RecordingConsentPlanVerbal.ts +++ b/src/api/types/RecordingConsentPlanVerbal.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requesting explicit verbal recording consent, including the announcement voice and action to take when the customer declines. + */ export interface RecordingConsentPlanVerbal { /** * This is the message asking for consent to record the call. @@ -14,6 +17,20 @@ export interface RecordingConsentPlanVerbal { * Use a different voice for the consent message for a better user experience. */ voice?: Vapi.RecordingConsentPlanVerbalVoice | undefined; + /** + * This controls whether the consent assistant speaks first or waits for the caller to speak first. + * + * Use: + * - `assistant-speaks-first` (default) to have the consent assistant play the consent message as soon as the call is answered. + * - `assistant-waits-for-user` to have the consent assistant wait for the caller to speak before playing the consent message. + * + * We strongly recommend `assistant-waits-for-user` for outbound calls. Some telephony providers signal "answered" while the line is still ringing, which can cause the consent message to play into a ringing line and be missed by the caller. Waiting for the caller to speak first guarantees they hear the full consent message. + * + * Note: when combined with `type: 'stay-on-line'`, silence only counts toward consent after the caller has spoken at least once. + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.RecordingConsentPlanVerbalFirstMessageMode | undefined; /** Tool to execute if user verbally declines recording consent */ declineTool?: Record | undefined; /** ID of existing tool to execute if user verbally declines recording consent */ diff --git a/src/api/types/RecordingConsentPlanVerbalFirstMessageMode.ts b/src/api/types/RecordingConsentPlanVerbalFirstMessageMode.ts new file mode 100644 index 00000000..4d3a54af --- /dev/null +++ b/src/api/types/RecordingConsentPlanVerbalFirstMessageMode.ts @@ -0,0 +1,21 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This controls whether the consent assistant speaks first or waits for the caller to speak first. + * + * Use: + * - `assistant-speaks-first` (default) to have the consent assistant play the consent message as soon as the call is answered. + * - `assistant-waits-for-user` to have the consent assistant wait for the caller to speak before playing the consent message. + * + * We strongly recommend `assistant-waits-for-user` for outbound calls. Some telephony providers signal "answered" while the line is still ringing, which can cause the consent message to play into a ringing line and be missed by the caller. Waiting for the caller to speak first guarantees they hear the full consent message. + * + * Note: when combined with `type: 'stay-on-line'`, silence only counts toward consent after the caller has spoken at least once. + * + * @default 'assistant-speaks-first' + */ +export const RecordingConsentPlanVerbalFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type RecordingConsentPlanVerbalFirstMessageMode = + (typeof RecordingConsentPlanVerbalFirstMessageMode)[keyof typeof RecordingConsentPlanVerbalFirstMessageMode]; diff --git a/src/api/types/RecordingConsentPlanVerbalVoice.ts b/src/api/types/RecordingConsentPlanVerbalVoice.ts index 95d9f1c9..491842b4 100644 --- a/src/api/types/RecordingConsentPlanVerbalVoice.ts +++ b/src/api/types/RecordingConsentPlanVerbalVoice.ts @@ -24,7 +24,9 @@ export type RecordingConsentPlanVerbalVoice = | Vapi.RecordingConsentPlanVerbalVoice.Vapi | Vapi.RecordingConsentPlanVerbalVoice.Sesame | Vapi.RecordingConsentPlanVerbalVoice.Inworld - | Vapi.RecordingConsentPlanVerbalVoice.Minimax; + | Vapi.RecordingConsentPlanVerbalVoice.Minimax + | Vapi.RecordingConsentPlanVerbalVoice.Xai + | Vapi.RecordingConsentPlanVerbalVoice.Microsoft; export namespace RecordingConsentPlanVerbalVoice { export interface Azure extends Vapi.AzureVoice { @@ -98,4 +100,12 @@ export namespace RecordingConsentPlanVerbalVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/RecordingConsentType.ts b/src/api/types/RecordingConsentType.ts new file mode 100644 index 00000000..5a882b65 --- /dev/null +++ b/src/api/types/RecordingConsentType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of recording consent. */ +export const RecordingConsentType = { + StayOnLine: "stay-on-line", + Verbal: "verbal", +} as const; +export type RecordingConsentType = (typeof RecordingConsentType)[keyof typeof RecordingConsentType]; diff --git a/src/api/types/RegexCondition.ts b/src/api/types/RegexCondition.ts index f8bd41e8..345f2094 100644 --- a/src/api/types/RegexCondition.ts +++ b/src/api/types/RegexCondition.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Evaluates whether targeted conversation-message content matches a regular expression. + */ export interface RegexCondition { /** * This is the regular expression pattern to match against message content. diff --git a/src/api/types/RegexOption.ts b/src/api/types/RegexOption.ts index 5dca3a7d..c3f6963f 100644 --- a/src/api/types/RegexOption.ts +++ b/src/api/types/RegexOption.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Enables or disables one regular-expression matching option for a text replacement. + */ export interface RegexOption { /** * This is the type of the regex option. Options are: diff --git a/src/api/types/RegexReplacement.ts b/src/api/types/RegexReplacement.ts index 92afdb21..33304eca 100644 --- a/src/api/types/RegexReplacement.ts +++ b/src/api/types/RegexReplacement.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Replaces text matching a regular expression before it is sent to a voice provider. + */ export interface RegexReplacement { /** * This is the regex pattern to replace. diff --git a/src/api/types/RegexSecurityFilter.ts b/src/api/types/RegexSecurityFilter.ts index 66805170..1ad256e9 100644 --- a/src/api/types/RegexSecurityFilter.ts +++ b/src/api/types/RegexSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters transcript content that matches a custom regular expression. + */ export interface RegexSecurityFilter { /** The type of security threat to filter. */ type: Vapi.RegexSecurityFilterType; diff --git a/src/api/types/RevokeInvitationResponseDto.ts b/src/api/types/RevokeInvitationResponseDto.ts new file mode 100644 index 00000000..613d9a73 --- /dev/null +++ b/src/api/types/RevokeInvitationResponseDto.ts @@ -0,0 +1,5 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface RevokeInvitationResponseDto { + success: boolean; +} diff --git a/src/api/types/RimeAiVoice.ts b/src/api/types/RimeAiVoice.ts index 1ed66a79..4d956c91 100644 --- a/src/api/types/RimeAiVoice.ts +++ b/src/api/types/RimeAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, caching, and fallback settings. + */ export interface RimeAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/S3CompatibleBucketPlan.ts b/src/api/types/S3CompatibleBucketPlan.ts new file mode 100644 index 00000000..34b1d5e7 --- /dev/null +++ b/src/api/types/S3CompatibleBucketPlan.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface S3CompatibleBucketPlan { + /** S3-compatible endpoint URL, such as https://s3.us-west-004.backblazeb2.com. Must be public HTTPS. */ + url: string; + /** SigV4 signing region expected by the object store. Most stores accept us-east-1. */ + region: string; + /** S3 access key ID. */ + accessKeyId: string; + /** S3 secret access key. This is not returned in the API. */ + secretAccessKey: string; + /** Bucket name. */ + name: string; + /** Optional key prefix inside the bucket, such as recordings/. */ + path?: string | undefined; +} diff --git a/src/api/types/S3CompatibleStorageCredential.ts b/src/api/types/S3CompatibleStorageCredential.ts new file mode 100644 index 00000000..af918b19 --- /dev/null +++ b/src/api/types/S3CompatibleStorageCredential.ts @@ -0,0 +1,21 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface S3CompatibleStorageCredential { + /** This is for S3-compatible storage such as MinIO, Garage, Ceph, or Backblaze B2. */ + provider: Vapi.S3CompatibleStorageCredentialProvider; + bucketPlan: Vapi.S3CompatibleBucketPlan; + /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ + fallbackIndex?: number | undefined; + /** This is the unique identifier for the credential. */ + id: string; + /** This is the unique identifier for the org that this credential belongs to. */ + orgId: string; + /** This is the ISO 8601 date-time string of when the credential was created. */ + createdAt: string; + /** This is the ISO 8601 date-time string of when the assistant was last updated. */ + updatedAt: string; + /** This is the name of credential. This is just for your reference. */ + name?: string | undefined; +} diff --git a/src/api/types/S3CompatibleStorageCredentialProvider.ts b/src/api/types/S3CompatibleStorageCredentialProvider.ts new file mode 100644 index 00000000..86bc0666 --- /dev/null +++ b/src/api/types/S3CompatibleStorageCredentialProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is for S3-compatible storage such as MinIO, Garage, Ceph, or Backblaze B2. */ +export const S3CompatibleStorageCredentialProvider = { + S3Compatible: "s3-compatible", +} as const; +export type S3CompatibleStorageCredentialProvider = + (typeof S3CompatibleStorageCredentialProvider)[keyof typeof S3CompatibleStorageCredentialProvider]; diff --git a/src/api/types/SayHookAction.ts b/src/api/types/SayHookAction.ts index c5273d21..df7e6e71 100644 --- a/src/api/types/SayHookAction.ts +++ b/src/api/types/SayHookAction.ts @@ -2,12 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that makes the assistant speak exact text or generate a response from a prompt. + */ export interface SayHookAction { + /** This is the exact message to say. When a string array is provided, one is randomly selected. */ + exact?: Vapi.SayHookActionExact | undefined; /** * This is the prompt for the assistant to generate a response based on existing conversation. * Can be a string or an array of chat messages. */ prompt?: Vapi.SayHookActionPrompt | undefined; - /** This is the message to say */ - exact?: Record | undefined; } diff --git a/src/api/types/SayHookActionExact.ts b/src/api/types/SayHookActionExact.ts new file mode 100644 index 00000000..1df332a5 --- /dev/null +++ b/src/api/types/SayHookActionExact.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the exact message to say. When a string array is provided, one is randomly selected. + */ +export type SayHookActionExact = string | string[]; diff --git a/src/api/types/SayPhoneNumberHookAction.ts b/src/api/types/SayPhoneNumberHookAction.ts index 5f0c9c37..95c812d1 100644 --- a/src/api/types/SayPhoneNumberHookAction.ts +++ b/src/api/types/SayPhoneNumberHookAction.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A phone-number hook action that speaks an exact message to the caller. + */ export interface SayPhoneNumberHookAction { /** This is the message to say */ exact: string; diff --git a/src/api/types/SbcConfiguration.ts b/src/api/types/SbcConfiguration.ts index e16bc574..70f83cef 100644 --- a/src/api/types/SbcConfiguration.ts +++ b/src/api/types/SbcConfiguration.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -export type SbcConfiguration = {}; +/** + * Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed controller. + */ +export type SbcConfiguration = unknown; diff --git a/src/api/types/ScenarioToolMock.ts b/src/api/types/ScenarioToolMock.ts index 7dab6a0e..9893d47f 100644 --- a/src/api/types/ScenarioToolMock.ts +++ b/src/api/types/ScenarioToolMock.ts @@ -1,10 +1,10 @@ // This file was auto-generated by Fern from our API Definition. export interface ScenarioToolMock { - /** This is the tool call function name to mock (must match `toolCall.function.name`). */ + /** The name of the assistant or squad's tool to mock. Must match the tool's name exactly. */ toolName: string; - /** This is the result content to return for this tool call. */ + /** The result string returned to the assistant or squad in place of calling the real tool. */ result?: string | undefined; - /** This is whether this mock is enabled. Defaults to true when omitted. */ + /** Set to `true` to apply this mock during the simulation. Defaults to `true`. */ enabled?: boolean | undefined; } diff --git a/src/api/types/SchedulePlan.ts b/src/api/types/SchedulePlan.ts index 3654c3bd..a9203327 100644 --- a/src/api/types/SchedulePlan.ts +++ b/src/api/types/SchedulePlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Time window that controls the earliest and latest time a call may begin. + */ export interface SchedulePlan { /** This is the ISO 8601 date-time string of the earliest time the call can be scheduled. */ earliestAt: string; diff --git a/src/api/types/Scorecard.ts b/src/api/types/Scorecard.ts index d5215c2a..9c3e905d 100644 --- a/src/api/types/Scorecard.ts +++ b/src/api/types/Scorecard.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive metadata, and lifecycle information. + */ export interface Scorecard { /** This is the unique identifier for the scorecard. */ id: string; diff --git a/src/api/types/ScorecardMetric.ts b/src/api/types/ScorecardMetric.ts index 1a96c31f..2b0ecafd 100644 --- a/src/api/types/ScorecardMetric.ts +++ b/src/api/types/ScorecardMetric.ts @@ -1,16 +1,21 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * A scorecard metric that awards points when a structured output meets its configured conditions. + */ export interface ScorecardMetric { - /** - * This is the unique identifier for the structured output that will be used to evaluate the scorecard. - * The structured output must be of type number or boolean only for now. - */ - structuredOutputId: string; /** * These are the conditions that will be used to evaluate the scorecard. * Each condition will have a comparator, value, and points that will be used to calculate the final score. * The points will be added to the overall score if the condition is met. * The overall score will be normalized to a 100 point scale to ensure uniformity across different scorecards. */ - conditions: Record[]; + conditions: Vapi.ScorecardMetricConditionsItem[]; + /** + * This is the unique identifier for the structured output that will be used to evaluate the scorecard. + * The structured output must be of type number or boolean only for now. + */ + structuredOutputId: string; } diff --git a/src/api/types/ScorecardMetricConditionsItem.ts b/src/api/types/ScorecardMetricConditionsItem.ts new file mode 100644 index 00000000..3bf9482a --- /dev/null +++ b/src/api/types/ScorecardMetricConditionsItem.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type ScorecardMetricConditionsItem = + | Vapi.NumberComparatorScorecardMetricCondition + | Vapi.BooleanComparatorScorecardMetricCondition; diff --git a/src/api/types/ScorecardPaginatedResponse.ts b/src/api/types/ScorecardPaginatedResponse.ts index dcf4b9be..de3ab05a 100644 --- a/src/api/types/ScorecardPaginatedResponse.ts +++ b/src/api/types/ScorecardPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of scorecards and metadata describing the result set. + */ export interface ScorecardPaginatedResponse { + /** The scorecards returned for the current page. */ results: Vapi.Scorecard[]; + /** Pagination metadata for the scorecard result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/SecurityFilterBase.ts b/src/api/types/SecurityFilterBase.ts index eb2e46d0..cd0564fe 100644 --- a/src/api/types/SecurityFilterBase.ts +++ b/src/api/types/SecurityFilterBase.ts @@ -1,3 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Base configuration for a security filter applied to transcripts before model processing. + */ export type SecurityFilterBase = {}; diff --git a/src/api/types/SecurityFilterPlan.ts b/src/api/types/SecurityFilterPlan.ts index 5458e337..b83fe075 100644 --- a/src/api/types/SecurityFilterPlan.ts +++ b/src/api/types/SecurityFilterPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls filtering of transcripts for security threats before content is sent to the assistant's language model, including filter selection, handling mode, and replacement text. + */ export interface SecurityFilterPlan { /** * Whether the security filter is enabled. diff --git a/src/api/types/Server.ts b/src/api/types/Server.ts index 3c60454c..f7e99a97 100644 --- a/src/api/types/Server.ts +++ b/src/api/types/Server.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, encryption, static IP addresses, and retry behavior. + */ export interface Server { /** * This is the timeout in seconds for the request. Defaults to 20 seconds. diff --git a/src/api/types/ServerMessageAssistantRequest.ts b/src/api/types/ServerMessageAssistantRequest.ts index a08347ff..8289eafb 100644 --- a/src/api/types/ServerMessageAssistantRequest.ts +++ b/src/api/types/ServerMessageAssistantRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageAssistantRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageAssistantRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "assistant-request" is sent to fetch assistant configuration for an incoming call. */ type: Vapi.ServerMessageAssistantRequestType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageAssistantSpeech.ts b/src/api/types/ServerMessageAssistantSpeech.ts index 9cdeb22b..e78cb9dc 100644 --- a/src/api/types/ServerMessageAssistantSpeech.ts +++ b/src/api/types/ServerMessageAssistantSpeech.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageAssistantSpeech { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageAssistantSpeechPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "assistant-speech" is sent as assistant audio is being played. */ type: Vapi.ServerMessageAssistantSpeechType; /** diff --git a/src/api/types/ServerMessageCallArtifactUpload.ts b/src/api/types/ServerMessageCallArtifactUpload.ts new file mode 100644 index 00000000..53a868bd --- /dev/null +++ b/src/api/types/ServerMessageCallArtifactUpload.ts @@ -0,0 +1,44 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ServerMessageCallArtifactUpload { + /** This is the phone number that the message is associated with. */ + phoneNumber?: Vapi.ServerMessageCallArtifactUploadPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; + /** + * This is the type of the message. "call.artifact.upload" is sent after a call + * to report whether each artifact was stored in your own configured storage. + */ + type: Vapi.ServerMessageCallArtifactUploadType; + /** + * One entry per artifact whose write targeted your own configured storage, + * each reporting whether that artifact was stored successfully. Artifacts that + * were not destined for your own storage (Vapi default storage, or no storage + * credential configured) are omitted, and this message is sent only when at + * least one artifact targeted your own storage. + */ + artifacts: Vapi.CallArtifactUploadItem[]; + /** This is the timestamp of the message. */ + timestamp?: number | undefined; + /** + * This is a live version of the `call.artifact`. + * + * This matches what is stored on `call.artifact` after the call. + */ + artifact?: Vapi.Artifact | undefined; + /** This is the assistant that the message is associated with. */ + assistant?: Vapi.CreateAssistantDto | undefined; + /** This is the customer that the message is associated with. */ + customer?: Vapi.CreateCustomerDto | undefined; + /** This is the call that the message is associated with. */ + call?: Vapi.Call | undefined; + /** This is the chat object. */ + chat?: Vapi.Chat | undefined; +} diff --git a/src/api/types/ServerMessageCallArtifactUploadPhoneNumber.ts b/src/api/types/ServerMessageCallArtifactUploadPhoneNumber.ts new file mode 100644 index 00000000..e4d3b068 --- /dev/null +++ b/src/api/types/ServerMessageCallArtifactUploadPhoneNumber.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the phone number that the message is associated with. + */ +export type ServerMessageCallArtifactUploadPhoneNumber = + | Vapi.ServerMessageCallArtifactUploadPhoneNumber.ByoPhoneNumber + | Vapi.ServerMessageCallArtifactUploadPhoneNumber.Twilio + | Vapi.ServerMessageCallArtifactUploadPhoneNumber.Vonage + | Vapi.ServerMessageCallArtifactUploadPhoneNumber.Vapi + | Vapi.ServerMessageCallArtifactUploadPhoneNumber.Telnyx; + +export namespace ServerMessageCallArtifactUploadPhoneNumber { + export interface ByoPhoneNumber extends Vapi.CreateByoPhoneNumberDto { + provider: "byo-phone-number"; + } + + export interface Twilio extends Vapi.CreateTwilioPhoneNumberDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonagePhoneNumberDto { + provider: "vonage"; + } + + export interface Vapi extends Vapi.CreateVapiPhoneNumberDto { + provider: "vapi"; + } + + export interface Telnyx extends Vapi.CreateTelnyxPhoneNumberDto { + provider: "telnyx"; + } +} diff --git a/src/api/types/ServerMessageCallArtifactUploadType.ts b/src/api/types/ServerMessageCallArtifactUploadType.ts new file mode 100644 index 00000000..72cbd508 --- /dev/null +++ b/src/api/types/ServerMessageCallArtifactUploadType.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the type of the message. "call.artifact.upload" is sent after a call + * to report whether each artifact was stored in your own configured storage. + */ +export const ServerMessageCallArtifactUploadType = { + CallArtifactUpload: "call.artifact.upload", +} as const; +export type ServerMessageCallArtifactUploadType = + (typeof ServerMessageCallArtifactUploadType)[keyof typeof ServerMessageCallArtifactUploadType]; diff --git a/src/api/types/ServerMessageCallDeleteFailed.ts b/src/api/types/ServerMessageCallDeleteFailed.ts index 4f975450..81f3f0aa 100644 --- a/src/api/types/ServerMessageCallDeleteFailed.ts +++ b/src/api/types/ServerMessageCallDeleteFailed.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageCallDeleteFailed { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageCallDeleteFailedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "call.deleted" is sent when a call is deleted. */ type: Vapi.ServerMessageCallDeleteFailedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageCallDeleted.ts b/src/api/types/ServerMessageCallDeleted.ts index e2790b2a..2ddffdf1 100644 --- a/src/api/types/ServerMessageCallDeleted.ts +++ b/src/api/types/ServerMessageCallDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageCallDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageCallDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "call.deleted" is sent when a call is deleted. */ type: Vapi.ServerMessageCallDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageCallEndpointingRequest.ts b/src/api/types/ServerMessageCallEndpointingRequest.ts index ccf9e97b..e01c8fa5 100644 --- a/src/api/types/ServerMessageCallEndpointingRequest.ts +++ b/src/api/types/ServerMessageCallEndpointingRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageCallEndpointingRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageCallEndpointingRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** * This is the type of the message. "call.endpointing.request" is sent when using `assistant.startSpeakingPlan.smartEndpointingPlan={ "provider": "custom-endpointing-model" }`. * diff --git a/src/api/types/ServerMessageCampaignPredial.ts b/src/api/types/ServerMessageCampaignPredial.ts new file mode 100644 index 00000000..4a63774c --- /dev/null +++ b/src/api/types/ServerMessageCampaignPredial.ts @@ -0,0 +1,37 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ServerMessageCampaignPredial { + /** This is the phone number that the message is associated with. */ + phoneNumber?: Vapi.ServerMessageCampaignPredialPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; + /** This is the type of the message. "campaign.predial" is sent to the campaign's server before each contact is dialed, so the server can decide whether the contact is eligible to be called. It is only sent when the campaign's `predialPlan` is set (and not disabled). */ + type: Vapi.ServerMessageCampaignPredialType; + /** This is the ID of the campaign the contact belongs to. */ + campaignId: string; + /** This is the contact that is about to be dialed. */ + contact: Vapi.CampaignContact; + /** This is the timestamp of the message. */ + timestamp?: number | undefined; + /** + * This is a live version of the `call.artifact`. + * + * This matches what is stored on `call.artifact` after the call. + */ + artifact?: Vapi.Artifact | undefined; + /** This is the assistant that the message is associated with. */ + assistant?: Vapi.CreateAssistantDto | undefined; + /** This is the customer that the message is associated with. */ + customer?: Vapi.CreateCustomerDto | undefined; + /** This is the call that the message is associated with. */ + call?: Vapi.Call | undefined; + /** This is the chat object. */ + chat?: Vapi.Chat | undefined; +} diff --git a/src/api/types/ServerMessageCampaignPredialPhoneNumber.ts b/src/api/types/ServerMessageCampaignPredialPhoneNumber.ts new file mode 100644 index 00000000..8e9793b7 --- /dev/null +++ b/src/api/types/ServerMessageCampaignPredialPhoneNumber.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the phone number that the message is associated with. + */ +export type ServerMessageCampaignPredialPhoneNumber = + | Vapi.ServerMessageCampaignPredialPhoneNumber.ByoPhoneNumber + | Vapi.ServerMessageCampaignPredialPhoneNumber.Twilio + | Vapi.ServerMessageCampaignPredialPhoneNumber.Vonage + | Vapi.ServerMessageCampaignPredialPhoneNumber.Vapi + | Vapi.ServerMessageCampaignPredialPhoneNumber.Telnyx; + +export namespace ServerMessageCampaignPredialPhoneNumber { + export interface ByoPhoneNumber extends Vapi.CreateByoPhoneNumberDto { + provider: "byo-phone-number"; + } + + export interface Twilio extends Vapi.CreateTwilioPhoneNumberDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonagePhoneNumberDto { + provider: "vonage"; + } + + export interface Vapi extends Vapi.CreateVapiPhoneNumberDto { + provider: "vapi"; + } + + export interface Telnyx extends Vapi.CreateTelnyxPhoneNumberDto { + provider: "telnyx"; + } +} diff --git a/src/api/types/ServerMessageCampaignPredialType.ts b/src/api/types/ServerMessageCampaignPredialType.ts new file mode 100644 index 00000000..df65bf6d --- /dev/null +++ b/src/api/types/ServerMessageCampaignPredialType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the message. "campaign.predial" is sent to the campaign's server before each contact is dialed, so the server can decide whether the contact is eligible to be called. It is only sent when the campaign's `predialPlan` is set (and not disabled). */ +export const ServerMessageCampaignPredialType = { + CampaignPredial: "campaign.predial", +} as const; +export type ServerMessageCampaignPredialType = + (typeof ServerMessageCampaignPredialType)[keyof typeof ServerMessageCampaignPredialType]; diff --git a/src/api/types/ServerMessageChatCreated.ts b/src/api/types/ServerMessageChatCreated.ts index 76e9f6a4..72075166 100644 --- a/src/api/types/ServerMessageChatCreated.ts +++ b/src/api/types/ServerMessageChatCreated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageChatCreated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageChatCreatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "chat.created" is sent when a new chat is created. */ type: Vapi.ServerMessageChatCreatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageChatDeleted.ts b/src/api/types/ServerMessageChatDeleted.ts index 154f9895..a01dfad8 100644 --- a/src/api/types/ServerMessageChatDeleted.ts +++ b/src/api/types/ServerMessageChatDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageChatDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageChatDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "chat.deleted" is sent when a chat is deleted. */ type: Vapi.ServerMessageChatDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageConversationUpdate.ts b/src/api/types/ServerMessageConversationUpdate.ts index ddf41954..cd64f30b 100644 --- a/src/api/types/ServerMessageConversationUpdate.ts +++ b/src/api/types/ServerMessageConversationUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageConversationUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageConversationUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "conversation-update" is sent when an update is committed to the conversation history. */ type: Vapi.ServerMessageConversationUpdateType; /** This is the most up-to-date conversation history at the time the message is sent. */ diff --git a/src/api/types/ServerMessageEndOfCallReport.ts b/src/api/types/ServerMessageEndOfCallReport.ts index a5cdac14..784a95bb 100644 --- a/src/api/types/ServerMessageEndOfCallReport.ts +++ b/src/api/types/ServerMessageEndOfCallReport.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageEndOfCallReport { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageEndOfCallReportPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "end-of-call-report" is sent when the call ends and post-processing is complete. */ type: Vapi.ServerMessageEndOfCallReportType; /** This is the reason the call ended. This can also be found at `call.endedReason` on GET /call/:id. */ diff --git a/src/api/types/ServerMessageEndOfCallReportEndedReason.ts b/src/api/types/ServerMessageEndOfCallReportEndedReason.ts index 31d6a875..d7637ae9 100644 --- a/src/api/types/ServerMessageEndOfCallReportEndedReason.ts +++ b/src/api/types/ServerMessageEndOfCallReportEndedReason.ts @@ -27,6 +27,7 @@ export const ServerMessageEndOfCallReportEndedReason = { CallStartErrorSubscriptionConcurrencyLimitReached: "call.start.error-subscription-concurrency-limit-reached", CallStartErrorEnterpriseFeatureNotAvailableRecordingConsent: "call.start.error-enterprise-feature-not-available-recording-consent", + CallStartAssistantVersionErrorValidation: "call.start.assistant-version-error-validation", AssistantNotValid: "assistant-not-valid", CallStartErrorVapifaultDatabaseError: "call.start.error-vapifault-database-error", AssistantNotFound: "assistant-not-found", @@ -46,6 +47,9 @@ export const ServerMessageEndOfCallReportEndedReason = { PipelineErrorInworldVoiceFailed: "pipeline-error-inworld-voice-failed", PipelineErrorMinimaxVoiceFailed: "pipeline-error-minimax-voice-failed", PipelineErrorWellsaidVoiceFailed: "pipeline-error-wellsaid-voice-failed", + PipelineErrorXaiVoiceFailed: "pipeline-error-xai-voice-failed", + PipelineErrorMicrosoftVoiceFailed: "pipeline-error-microsoft-voice-failed", + PipelineErrorMicrosoftVoiceRequestCanceled: "pipeline-error-microsoft-voice-request-canceled", PipelineErrorTavusVideoFailed: "pipeline-error-tavus-video-failed", CallInProgressErrorVapifaultOpenaiVoiceFailed: "call.in-progress.error-vapifault-openai-voice-failed", CallInProgressErrorVapifaultCartesiaVoiceFailed: "call.in-progress.error-vapifault-cartesia-voice-failed", @@ -63,6 +67,8 @@ export const ServerMessageEndOfCallReportEndedReason = { CallInProgressErrorVapifaultInworldVoiceFailed: "call.in-progress.error-vapifault-inworld-voice-failed", CallInProgressErrorVapifaultMinimaxVoiceFailed: "call.in-progress.error-vapifault-minimax-voice-failed", CallInProgressErrorVapifaultWellsaidVoiceFailed: "call.in-progress.error-vapifault-wellsaid-voice-failed", + CallInProgressErrorVapifaultXaiVoiceFailed: "call.in-progress.error-vapifault-xai-voice-failed", + CallInProgressErrorVapifaultMicrosoftVoiceFailed: "call.in-progress.error-vapifault-microsoft-voice-failed", CallInProgressErrorVapifaultTavusVideoFailed: "call.in-progress.error-vapifault-tavus-video-failed", PipelineErrorVapiLlmFailed: "pipeline-error-vapi-llm-failed", PipelineErrorVapi400BadRequestValidationFailed: "pipeline-error-vapi-400-bad-request-validation-failed", @@ -72,6 +78,7 @@ export const ServerMessageEndOfCallReportEndedReason = { PipelineErrorVapi500ServerError: "pipeline-error-vapi-500-server-error", PipelineErrorVapi503ServerOverloadedError: "pipeline-error-vapi-503-server-overloaded-error", CallInProgressErrorProviderfaultVapiLlmFailed: "call.in-progress.error-providerfault-vapi-llm-failed", + CallInProgressErrorVapifaultVapiLlmFailed: "call.in-progress.error-vapifault-vapi-llm-failed", CallInProgressErrorVapifaultVapi400BadRequestValidationFailed: "call.in-progress.error-vapifault-vapi-400-bad-request-validation-failed", CallInProgressErrorVapifaultVapi401Unauthorized: "call.in-progress.error-vapifault-vapi-401-unauthorized", @@ -81,6 +88,11 @@ export const ServerMessageEndOfCallReportEndedReason = { CallInProgressErrorProviderfaultVapi500ServerError: "call.in-progress.error-providerfault-vapi-500-server-error", CallInProgressErrorProviderfaultVapi503ServerOverloadedError: "call.in-progress.error-providerfault-vapi-503-server-overloaded-error", + PipelineErrorVapiTranscriberFailed: "pipeline-error-vapi-transcriber-failed", + CallInProgressErrorVapifaultVapiTranscriberFailed: "call.in-progress.error-vapifault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiTranscriberFailed: + "call.in-progress.error-providerfault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiVoiceFailed: "call.in-progress.error-providerfault-vapi-voice-failed", PipelineErrorDeepgramTranscriberFailed: "pipeline-error-deepgram-transcriber-failed", PipelineErrorDeepgramTranscriberApiKeyMissing: "pipeline-error-deepgram-transcriber-api-key-missing", CallInProgressErrorVapifaultDeepgramTranscriberFailed: @@ -137,6 +149,23 @@ export const ServerMessageEndOfCallReportEndedReason = { CallInProgressErrorVapifaultSonioxTranscriberServerError: "call.in-progress.error-vapifault-soniox-transcriber-server-error", CallInProgressErrorVapifaultSonioxTranscriberFailed: "call.in-progress.error-vapifault-soniox-transcriber-failed", + PipelineErrorXaiTranscriberAuthFailed: "pipeline-error-xai-transcriber-auth-failed", + PipelineErrorXaiTranscriberRateLimited: "pipeline-error-xai-transcriber-rate-limited", + PipelineErrorXaiTranscriberInvalidConfig: "pipeline-error-xai-transcriber-invalid-config", + PipelineErrorXaiTranscriberServerError: "pipeline-error-xai-transcriber-server-error", + PipelineErrorXaiTranscriberFailed: "pipeline-error-xai-transcriber-failed", + CallInProgressErrorVapifaultXaiTranscriberAuthFailed: + "call.in-progress.error-vapifault-xai-transcriber-auth-failed", + CallInProgressErrorVapifaultXaiTranscriberRateLimited: + "call.in-progress.error-vapifault-xai-transcriber-rate-limited", + CallInProgressErrorVapifaultXaiTranscriberInvalidConfig: + "call.in-progress.error-vapifault-xai-transcriber-invalid-config", + CallInProgressErrorVapifaultXaiTranscriberServerError: + "call.in-progress.error-vapifault-xai-transcriber-server-error", + CallInProgressErrorVapifaultXaiTranscriberFailed: "call.in-progress.error-vapifault-xai-transcriber-failed", + PipelineErrorCartesiaTranscriberFailed: "pipeline-error-cartesia-transcriber-failed", + CallInProgressErrorVapifaultCartesiaTranscriberFailed: + "call.in-progress.error-vapifault-cartesia-transcriber-failed", CallInProgressErrorPipelineNoAvailableLlmModel: "call.in-progress.error-pipeline-no-available-llm-model", WorkerShutdown: "worker-shutdown", VonageDisconnected: "vonage-disconnected", @@ -749,6 +778,7 @@ export const ServerMessageEndOfCallReportEndedReason = { ManuallyCanceled: "manually-canceled", PhoneCallProviderClosedWebsocket: "phone-call-provider-closed-websocket", CallForwardingOperatorBusy: "call.forwarding.operator-busy", + CallForwardingNoAnswer: "call.forwarding.no-answer", SilenceTimedOut: "silence-timed-out", CallInProgressErrorProviderfaultOutboundSip403Forbidden: "call.in-progress.error-providerfault-outbound-sip-403-forbidden", diff --git a/src/api/types/ServerMessageHandoffDestinationRequest.ts b/src/api/types/ServerMessageHandoffDestinationRequest.ts index 5d4ff96c..c204d430 100644 --- a/src/api/types/ServerMessageHandoffDestinationRequest.ts +++ b/src/api/types/ServerMessageHandoffDestinationRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageHandoffDestinationRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageHandoffDestinationRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "handoff-destination-request" is sent when the model is requesting handoff but destination is unknown. */ type: Vapi.ServerMessageHandoffDestinationRequestType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageHang.ts b/src/api/types/ServerMessageHang.ts index 6dcaef6b..464e3893 100644 --- a/src/api/types/ServerMessageHang.ts +++ b/src/api/types/ServerMessageHang.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageHang { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageHangPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** * This is the type of the message. "hang" is sent when the assistant is hanging due to a delay. The delay can be caused by many factors, such as: * - the model is too slow to respond diff --git a/src/api/types/ServerMessageKnowledgeBaseRequest.ts b/src/api/types/ServerMessageKnowledgeBaseRequest.ts index f74a35d5..526710fa 100644 --- a/src/api/types/ServerMessageKnowledgeBaseRequest.ts +++ b/src/api/types/ServerMessageKnowledgeBaseRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageKnowledgeBaseRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageKnowledgeBaseRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "knowledge-base-request" is sent to request knowledge base documents. To enable, use `assistant.knowledgeBase.provider=custom-knowledge-base`. */ type: Vapi.ServerMessageKnowledgeBaseRequestType; /** These are the messages that are going to be sent to the `model` right after the `knowledge-base-request` webhook completes. */ diff --git a/src/api/types/ServerMessageLanguageChangeDetected.ts b/src/api/types/ServerMessageLanguageChangeDetected.ts index 974f85e1..fc53867a 100644 --- a/src/api/types/ServerMessageLanguageChangeDetected.ts +++ b/src/api/types/ServerMessageLanguageChangeDetected.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageLanguageChangeDetected { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageLanguageChangeDetectedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "language-change-detected" is sent when the transcriber is automatically switched based on the detected language. */ type: Vapi.ServerMessageLanguageChangeDetectedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageMessage.ts b/src/api/types/ServerMessageMessage.ts index 8e6e6e95..4b0b441d 100644 --- a/src/api/types/ServerMessageMessage.ts +++ b/src/api/types/ServerMessageMessage.ts @@ -39,4 +39,6 @@ export type ServerMessageMessage = | Vapi.ServerMessageSessionUpdated | Vapi.ServerMessageSessionDeleted | Vapi.ServerMessageCallDeleted - | Vapi.ServerMessageCallDeleteFailed; + | Vapi.ServerMessageCallDeleteFailed + | Vapi.ServerMessageCallArtifactUpload + | Vapi.ServerMessageCampaignPredial; diff --git a/src/api/types/ServerMessageModelOutput.ts b/src/api/types/ServerMessageModelOutput.ts index 1bb2cb62..5a579a82 100644 --- a/src/api/types/ServerMessageModelOutput.ts +++ b/src/api/types/ServerMessageModelOutput.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageModelOutput { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageModelOutputPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "model-output" is sent as the model outputs tokens. */ type: Vapi.ServerMessageModelOutputType; /** diff --git a/src/api/types/ServerMessagePhoneCallControl.ts b/src/api/types/ServerMessagePhoneCallControl.ts index 2def63e8..2067aeb9 100644 --- a/src/api/types/ServerMessagePhoneCallControl.ts +++ b/src/api/types/ServerMessagePhoneCallControl.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessagePhoneCallControl { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessagePhoneCallControlPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** * This is the type of the message. "phone-call-control" is an advanced type of message. * diff --git a/src/api/types/ServerMessageResponseCampaignPredial.ts b/src/api/types/ServerMessageResponseCampaignPredial.ts new file mode 100644 index 00000000..9358aa32 --- /dev/null +++ b/src/api/types/ServerMessageResponseCampaignPredial.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface ServerMessageResponseCampaignPredial { + /** This is whether the contact is eligible to be dialed. `true` places the call; `false` skips the contact. Any other response — a missing or non-boolean `eligible`, an unreachable server, an error, or a timeout — records a pre-dial failure for the contact and the call is not placed. */ + eligible: boolean; +} diff --git a/src/api/types/ServerMessageResponseMessageResponse.ts b/src/api/types/ServerMessageResponseMessageResponse.ts index 26b47bba..f42d6a63 100644 --- a/src/api/types/ServerMessageResponseMessageResponse.ts +++ b/src/api/types/ServerMessageResponseMessageResponse.ts @@ -14,4 +14,5 @@ export type ServerMessageResponseMessageResponse = | Vapi.ServerMessageResponseToolCalls | Vapi.ServerMessageResponseTransferDestinationRequest | Vapi.ServerMessageResponseVoiceRequest - | Vapi.ServerMessageResponseCallEndpointingRequest; + | Vapi.ServerMessageResponseCallEndpointingRequest + | Vapi.ServerMessageResponseCampaignPredial; diff --git a/src/api/types/ServerMessageSessionCreated.ts b/src/api/types/ServerMessageSessionCreated.ts index 44d6cc15..85b3e61e 100644 --- a/src/api/types/ServerMessageSessionCreated.ts +++ b/src/api/types/ServerMessageSessionCreated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageSessionCreated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageSessionCreatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.created" is sent when a new session is created. */ type: Vapi.ServerMessageSessionCreatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageSessionDeleted.ts b/src/api/types/ServerMessageSessionDeleted.ts index 0a091075..d94988a9 100644 --- a/src/api/types/ServerMessageSessionDeleted.ts +++ b/src/api/types/ServerMessageSessionDeleted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageSessionDeleted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageSessionDeletedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.deleted" is sent when a session is deleted. */ type: Vapi.ServerMessageSessionDeletedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageSessionUpdated.ts b/src/api/types/ServerMessageSessionUpdated.ts index e4d7ff2b..c9989c9e 100644 --- a/src/api/types/ServerMessageSessionUpdated.ts +++ b/src/api/types/ServerMessageSessionUpdated.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageSessionUpdated { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageSessionUpdatedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "session.updated" is sent when a session is updated. */ type: Vapi.ServerMessageSessionUpdatedType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageSpeechUpdate.ts b/src/api/types/ServerMessageSpeechUpdate.ts index 75f1ffe4..2757560f 100644 --- a/src/api/types/ServerMessageSpeechUpdate.ts +++ b/src/api/types/ServerMessageSpeechUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageSpeechUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageSpeechUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "speech-update" is sent whenever assistant or user start or stop speaking. */ type: Vapi.ServerMessageSpeechUpdateType; /** This is the status of the speech update. */ diff --git a/src/api/types/ServerMessageStatusUpdate.ts b/src/api/types/ServerMessageStatusUpdate.ts index cf8b3b78..70522d4d 100644 --- a/src/api/types/ServerMessageStatusUpdate.ts +++ b/src/api/types/ServerMessageStatusUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageStatusUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageStatusUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "status-update" is sent whenever the `call.status` changes. */ type: Vapi.ServerMessageStatusUpdateType; /** This is the status of the call. */ diff --git a/src/api/types/ServerMessageStatusUpdateEndedReason.ts b/src/api/types/ServerMessageStatusUpdateEndedReason.ts index 2a3fc068..48c473b3 100644 --- a/src/api/types/ServerMessageStatusUpdateEndedReason.ts +++ b/src/api/types/ServerMessageStatusUpdateEndedReason.ts @@ -27,6 +27,7 @@ export const ServerMessageStatusUpdateEndedReason = { CallStartErrorSubscriptionConcurrencyLimitReached: "call.start.error-subscription-concurrency-limit-reached", CallStartErrorEnterpriseFeatureNotAvailableRecordingConsent: "call.start.error-enterprise-feature-not-available-recording-consent", + CallStartAssistantVersionErrorValidation: "call.start.assistant-version-error-validation", AssistantNotValid: "assistant-not-valid", CallStartErrorVapifaultDatabaseError: "call.start.error-vapifault-database-error", AssistantNotFound: "assistant-not-found", @@ -46,6 +47,9 @@ export const ServerMessageStatusUpdateEndedReason = { PipelineErrorInworldVoiceFailed: "pipeline-error-inworld-voice-failed", PipelineErrorMinimaxVoiceFailed: "pipeline-error-minimax-voice-failed", PipelineErrorWellsaidVoiceFailed: "pipeline-error-wellsaid-voice-failed", + PipelineErrorXaiVoiceFailed: "pipeline-error-xai-voice-failed", + PipelineErrorMicrosoftVoiceFailed: "pipeline-error-microsoft-voice-failed", + PipelineErrorMicrosoftVoiceRequestCanceled: "pipeline-error-microsoft-voice-request-canceled", PipelineErrorTavusVideoFailed: "pipeline-error-tavus-video-failed", CallInProgressErrorVapifaultOpenaiVoiceFailed: "call.in-progress.error-vapifault-openai-voice-failed", CallInProgressErrorVapifaultCartesiaVoiceFailed: "call.in-progress.error-vapifault-cartesia-voice-failed", @@ -63,6 +67,8 @@ export const ServerMessageStatusUpdateEndedReason = { CallInProgressErrorVapifaultInworldVoiceFailed: "call.in-progress.error-vapifault-inworld-voice-failed", CallInProgressErrorVapifaultMinimaxVoiceFailed: "call.in-progress.error-vapifault-minimax-voice-failed", CallInProgressErrorVapifaultWellsaidVoiceFailed: "call.in-progress.error-vapifault-wellsaid-voice-failed", + CallInProgressErrorVapifaultXaiVoiceFailed: "call.in-progress.error-vapifault-xai-voice-failed", + CallInProgressErrorVapifaultMicrosoftVoiceFailed: "call.in-progress.error-vapifault-microsoft-voice-failed", CallInProgressErrorVapifaultTavusVideoFailed: "call.in-progress.error-vapifault-tavus-video-failed", PipelineErrorVapiLlmFailed: "pipeline-error-vapi-llm-failed", PipelineErrorVapi400BadRequestValidationFailed: "pipeline-error-vapi-400-bad-request-validation-failed", @@ -72,6 +78,7 @@ export const ServerMessageStatusUpdateEndedReason = { PipelineErrorVapi500ServerError: "pipeline-error-vapi-500-server-error", PipelineErrorVapi503ServerOverloadedError: "pipeline-error-vapi-503-server-overloaded-error", CallInProgressErrorProviderfaultVapiLlmFailed: "call.in-progress.error-providerfault-vapi-llm-failed", + CallInProgressErrorVapifaultVapiLlmFailed: "call.in-progress.error-vapifault-vapi-llm-failed", CallInProgressErrorVapifaultVapi400BadRequestValidationFailed: "call.in-progress.error-vapifault-vapi-400-bad-request-validation-failed", CallInProgressErrorVapifaultVapi401Unauthorized: "call.in-progress.error-vapifault-vapi-401-unauthorized", @@ -81,6 +88,11 @@ export const ServerMessageStatusUpdateEndedReason = { CallInProgressErrorProviderfaultVapi500ServerError: "call.in-progress.error-providerfault-vapi-500-server-error", CallInProgressErrorProviderfaultVapi503ServerOverloadedError: "call.in-progress.error-providerfault-vapi-503-server-overloaded-error", + PipelineErrorVapiTranscriberFailed: "pipeline-error-vapi-transcriber-failed", + CallInProgressErrorVapifaultVapiTranscriberFailed: "call.in-progress.error-vapifault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiTranscriberFailed: + "call.in-progress.error-providerfault-vapi-transcriber-failed", + CallInProgressErrorProviderfaultVapiVoiceFailed: "call.in-progress.error-providerfault-vapi-voice-failed", PipelineErrorDeepgramTranscriberFailed: "pipeline-error-deepgram-transcriber-failed", PipelineErrorDeepgramTranscriberApiKeyMissing: "pipeline-error-deepgram-transcriber-api-key-missing", CallInProgressErrorVapifaultDeepgramTranscriberFailed: @@ -137,6 +149,23 @@ export const ServerMessageStatusUpdateEndedReason = { CallInProgressErrorVapifaultSonioxTranscriberServerError: "call.in-progress.error-vapifault-soniox-transcriber-server-error", CallInProgressErrorVapifaultSonioxTranscriberFailed: "call.in-progress.error-vapifault-soniox-transcriber-failed", + PipelineErrorXaiTranscriberAuthFailed: "pipeline-error-xai-transcriber-auth-failed", + PipelineErrorXaiTranscriberRateLimited: "pipeline-error-xai-transcriber-rate-limited", + PipelineErrorXaiTranscriberInvalidConfig: "pipeline-error-xai-transcriber-invalid-config", + PipelineErrorXaiTranscriberServerError: "pipeline-error-xai-transcriber-server-error", + PipelineErrorXaiTranscriberFailed: "pipeline-error-xai-transcriber-failed", + CallInProgressErrorVapifaultXaiTranscriberAuthFailed: + "call.in-progress.error-vapifault-xai-transcriber-auth-failed", + CallInProgressErrorVapifaultXaiTranscriberRateLimited: + "call.in-progress.error-vapifault-xai-transcriber-rate-limited", + CallInProgressErrorVapifaultXaiTranscriberInvalidConfig: + "call.in-progress.error-vapifault-xai-transcriber-invalid-config", + CallInProgressErrorVapifaultXaiTranscriberServerError: + "call.in-progress.error-vapifault-xai-transcriber-server-error", + CallInProgressErrorVapifaultXaiTranscriberFailed: "call.in-progress.error-vapifault-xai-transcriber-failed", + PipelineErrorCartesiaTranscriberFailed: "pipeline-error-cartesia-transcriber-failed", + CallInProgressErrorVapifaultCartesiaTranscriberFailed: + "call.in-progress.error-vapifault-cartesia-transcriber-failed", CallInProgressErrorPipelineNoAvailableLlmModel: "call.in-progress.error-pipeline-no-available-llm-model", WorkerShutdown: "worker-shutdown", VonageDisconnected: "vonage-disconnected", @@ -749,6 +778,7 @@ export const ServerMessageStatusUpdateEndedReason = { ManuallyCanceled: "manually-canceled", PhoneCallProviderClosedWebsocket: "phone-call-provider-closed-websocket", CallForwardingOperatorBusy: "call.forwarding.operator-busy", + CallForwardingNoAnswer: "call.forwarding.no-answer", SilenceTimedOut: "silence-timed-out", CallInProgressErrorProviderfaultOutboundSip403Forbidden: "call.in-progress.error-providerfault-outbound-sip-403-forbidden", diff --git a/src/api/types/ServerMessageToolCalls.ts b/src/api/types/ServerMessageToolCalls.ts index 35d0f482..ceda7c43 100644 --- a/src/api/types/ServerMessageToolCalls.ts +++ b/src/api/types/ServerMessageToolCalls.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageToolCalls { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageToolCallsPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "tool-calls" is sent to call a tool. */ type?: Vapi.ServerMessageToolCallsType | undefined; /** This is the list of tools calls that the model is requesting along with the original tool configuration. */ diff --git a/src/api/types/ServerMessageTranscript.ts b/src/api/types/ServerMessageTranscript.ts index 0b042359..44cefcbc 100644 --- a/src/api/types/ServerMessageTranscript.ts +++ b/src/api/types/ServerMessageTranscript.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageTranscript { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageTranscriptPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "transcript" is sent as transcriber outputs partial or final transcript. */ type: Vapi.ServerMessageTranscriptType; /** This is the timestamp of the message. */ @@ -29,6 +36,16 @@ export interface ServerMessageTranscript { transcriptType: Vapi.ServerMessageTranscriptTranscriptType; /** This is the transcript content. */ transcript: string; + /** + * The ID of the assistant that produced this transcript. Present on + * assistant-role events when an active assistant ID is available. + */ + assistantId?: string | undefined; + /** + * The name of the assistant that produced this transcript. Present on + * assistant-role events when an active assistant name is available. + */ + assistantName?: string | undefined; /** Indicates if the transcript was filtered for security reasons. */ isFiltered?: boolean | undefined; /** List of detected security threats if the transcript was filtered. */ diff --git a/src/api/types/ServerMessageTransferDestinationRequest.ts b/src/api/types/ServerMessageTransferDestinationRequest.ts index 911ce59e..ea511b1a 100644 --- a/src/api/types/ServerMessageTransferDestinationRequest.ts +++ b/src/api/types/ServerMessageTransferDestinationRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageTransferDestinationRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageTransferDestinationRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "transfer-destination-request" is sent when the model is requesting transfer but destination is unknown. */ type: Vapi.ServerMessageTransferDestinationRequestType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageTransferUpdate.ts b/src/api/types/ServerMessageTransferUpdate.ts index 34d6d09e..674a973a 100644 --- a/src/api/types/ServerMessageTransferUpdate.ts +++ b/src/api/types/ServerMessageTransferUpdate.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageTransferUpdate { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageTransferUpdatePhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "transfer-update" is sent whenever a transfer happens. */ type: Vapi.ServerMessageTransferUpdateType; /** This is the destination of the transfer. */ diff --git a/src/api/types/ServerMessageUserInterrupted.ts b/src/api/types/ServerMessageUserInterrupted.ts index f1abe3a2..507df326 100644 --- a/src/api/types/ServerMessageUserInterrupted.ts +++ b/src/api/types/ServerMessageUserInterrupted.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageUserInterrupted { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageUserInterruptedPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "user-interrupted" is sent when the user interrupts the assistant. */ type: Vapi.ServerMessageUserInterruptedType; /** diff --git a/src/api/types/ServerMessageVoiceInput.ts b/src/api/types/ServerMessageVoiceInput.ts index 90012bb0..26a113c3 100644 --- a/src/api/types/ServerMessageVoiceInput.ts +++ b/src/api/types/ServerMessageVoiceInput.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageVoiceInput { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageVoiceInputPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** This is the type of the message. "voice-input" is sent when a generation is requested from voice provider. */ type: Vapi.ServerMessageVoiceInputType; /** This is the timestamp of the message. */ diff --git a/src/api/types/ServerMessageVoiceRequest.ts b/src/api/types/ServerMessageVoiceRequest.ts index e46f831b..29b4db0f 100644 --- a/src/api/types/ServerMessageVoiceRequest.ts +++ b/src/api/types/ServerMessageVoiceRequest.ts @@ -5,6 +5,13 @@ import type * as Vapi from "../index.js"; export interface ServerMessageVoiceRequest { /** This is the phone number that the message is associated with. */ phoneNumber?: Vapi.ServerMessageVoiceRequestPhoneNumber | undefined; + /** + * This is the version label (e.g. `v3`) of the assistant the call was + * configured with. `null` for inline assistants, squad/workflow calls, + * pre-resolution assistant-request messages, and orgs not on + * assistant versioning. + */ + assistantVersion?: (string | null) | undefined; /** * This is the type of the message. "voice-request" is sent when using `assistant.voice={ "type": "custom-voice" }`. * diff --git a/src/api/types/SesameVoice.ts b/src/api/types/SesameVoice.ts index d577279e..5ce52306 100644 --- a/src/api/types/SesameVoice.ts +++ b/src/api/types/SesameVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, caching, and fallback settings. + */ export interface SesameVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/SimulationRun.ts b/src/api/types/SimulationRun.ts index 9c5f1e14..b9dc9c96 100644 --- a/src/api/types/SimulationRun.ts +++ b/src/api/types/SimulationRun.ts @@ -7,7 +7,7 @@ export interface SimulationRun { id: string; /** Organization ID */ orgId: string; - /** Current status of the run */ + /** The run's current status. One of `queued`, `running`, or `ended`. */ status: Vapi.SimulationRunStatus; /** When the run was queued */ queuedAt: string; @@ -15,20 +15,20 @@ export interface SimulationRun { startedAt?: string | undefined; /** When the run ended */ endedAt?: string | undefined; - /** Reason the run ended */ + /** Why the run ended, when applicable. */ endedReason?: string | undefined; /** ISO 8601 date-time when created */ createdAt: string; /** ISO 8601 date-time when last updated */ updatedAt: string; - /** Aggregate counts of run items by status */ + /** Aggregate counts of the run's items by status. */ itemCounts?: Vapi.SimulationRunItemCounts | undefined; - /** Array of simulations and/or suites to run */ + /** The simulations and suites included in the run. */ simulations: Vapi.SimulationRunSimulationsItem[]; - /** Target to test against */ + /** The assistant or squad the run was tested against. */ target: Vapi.SimulationRunTarget; - /** Number of times to run each simulation (default: 1) */ + /** The number of times each simulation was run. Defaults to 1. */ iterations?: number | undefined; - /** Transport configuration for the simulation runs */ + /** The transport used for the run, either voice or chat. */ transport?: Vapi.SimulationRunTransportConfiguration | undefined; } diff --git a/src/api/types/SimulationRunItem.ts b/src/api/types/SimulationRunItem.ts index 292e47a6..fd6802f9 100644 --- a/src/api/types/SimulationRunItem.ts +++ b/src/api/types/SimulationRunItem.ts @@ -9,7 +9,7 @@ export interface SimulationRunItem { orgId: string; /** This is the ID of the simulation this run belongs to. */ simulationId: string; - /** This is the current status of the run. */ + /** The run item's current status. */ status: Vapi.SimulationRunItemStatus; /** This is the ISO 8601 date-time string of when the run was queued. */ queuedAt: string; @@ -21,9 +21,9 @@ export interface SimulationRunItem { failedAt?: string | undefined; /** This is the ISO 8601 date-time string of when the run was canceled. */ canceledAt?: string | undefined; - /** This is the reason for failure. */ + /** Why the run item failed, when applicable. */ failureReason?: string | undefined; - /** This is the ID of the target Vapi call (the assistant being tested). */ + /** The ID of the call that ran this item. */ callId?: string | undefined; /** This is the ISO 8601 date-time string of when the run item was created. */ createdAt: string; @@ -33,19 +33,19 @@ export interface SimulationRunItem { runId?: string | undefined; /** Hooks configured for this simulation run item */ hooks?: Vapi.SimulationRunItemHooksItem[] | undefined; - /** This is the iteration number (1-indexed) when run with iterations > 1. */ + /** Which iteration of the simulation this item represents. */ iterationNumber?: number | undefined; /** This is the session ID for chat-based simulations (webchat transport). */ sessionId?: string | undefined; - /** This is the scenario ID at run creation time. */ + /** The ID of the scenario used for this run item. */ scenarioId?: string | undefined; - /** This is the personality ID at run creation time. */ + /** The ID of the personality used for this run item. */ personalityId?: string | undefined; /** This is the metadata containing snapshots and call data. */ metadata?: Vapi.SimulationRunItemMetadata | undefined; - /** This is the results of the simulation run. */ + /** The evaluation results for this run item. */ results?: Vapi.SimulationRunItemResults | undefined; - /** This is the AI-generated improvement suggestions for failed runs. */ + /** AI-generated suggestions for improving the assistant or squad's system prompt, tools, and scenarios after a failed run. */ improvementSuggestions?: Vapi.SimulationRunItemImprovements | undefined; /** This is the configuration for how this simulation run executes. */ configurations?: Vapi.SimulationRunConfiguration | undefined; diff --git a/src/api/types/SimulationRunItemCounts.ts b/src/api/types/SimulationRunItemCounts.ts index 4c814ff5..2fed02d4 100644 --- a/src/api/types/SimulationRunItemCounts.ts +++ b/src/api/types/SimulationRunItemCounts.ts @@ -1,16 +1,20 @@ // This file was auto-generated by Fern from our API Definition. export interface SimulationRunItemCounts { - /** Total number of run items */ + /** The total number of run items. */ total: number; - /** Number of passed run items */ + /** The number of run items that passed all required evaluations. */ passed: number; - /** Number of failed run items */ + /** The number of run items that failed at least one required evaluation. */ failed: number; - /** Number of running/evaluating run items */ + /** The number of run items currently running or evaluating. */ running: number; - /** Number of queued run items */ + /** The number of run items waiting to start. */ queued: number; - /** Number of canceled run items */ + /** The number of run items that were canceled. */ canceled: number; + /** Number of distinct simulations represented by the run items. Omitted when any item has no simulation ID. */ + distinctSimulationTotal?: number | undefined; + /** Number of distinct simulations with a failed or canceled item. Omitted when any item has no simulation ID. */ + distinctSimulationFailed?: number | undefined; } diff --git a/src/api/types/SimulationRunItemStatus.ts b/src/api/types/SimulationRunItemStatus.ts index 4b057a06..f1a42737 100644 --- a/src/api/types/SimulationRunItemStatus.ts +++ b/src/api/types/SimulationRunItemStatus.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** This is the current status of the run. */ +/** The run item's current status. */ export const SimulationRunItemStatus = { Queued: "queued", Running: "running", diff --git a/src/api/types/SimulationRunListItem.ts b/src/api/types/SimulationRunListItem.ts new file mode 100644 index 00000000..a65661c7 --- /dev/null +++ b/src/api/types/SimulationRunListItem.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationRunListItem { + /** Unique identifier for the run */ + id: string; + /** Organization ID */ + orgId: string; + /** Current status of the run */ + status: Vapi.SimulationRunListItemStatus; + /** When the run was queued */ + queuedAt: string; + /** When the run started */ + startedAt?: string | undefined; + /** When the run ended */ + endedAt?: string | undefined; + /** Reason the run ended */ + endedReason?: string | undefined; + /** ISO 8601 date-time when created */ + createdAt: string; + /** ISO 8601 date-time when last updated */ + updatedAt: string; + /** Aggregate counts of run items by status */ + itemCounts?: Vapi.SimulationRunItemCounts | undefined; + /** Array of simulations and/or suites to run */ + simulations: Vapi.SimulationRunListItemSimulationsItem[]; + /** Target to test against */ + target: Vapi.SimulationRunListItemTarget; + /** Number of times to run each simulation (default: 1) */ + iterations?: number | undefined; + /** Transport configuration for the simulation runs */ + transport?: Vapi.SimulationRunTransportConfiguration | undefined; + summary: Vapi.SimulationRunListSummary; +} diff --git a/src/api/types/SimulationRunListItemSimulationsItem.ts b/src/api/types/SimulationRunListItemSimulationsItem.ts new file mode 100644 index 00000000..f1cfa8a7 --- /dev/null +++ b/src/api/types/SimulationRunListItemSimulationsItem.ts @@ -0,0 +1,24 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type SimulationRunListItemSimulationsItem = + | Vapi.SimulationRunListItemSimulationsItem.Simulation + | Vapi.SimulationRunListItemSimulationsItem.SimulationSuite; + +export namespace SimulationRunListItemSimulationsItem { + export interface Simulation extends Vapi.SimulationRunSimulationEntry { + type: "simulation"; + } + + export interface SimulationSuite extends Vapi.SimulationRunSuiteEntry { + type: "simulationSuite"; + } + + export type Request = + | Vapi.SimulationRunListItemSimulationsItem.Simulation + | Vapi.SimulationRunListItemSimulationsItem.SimulationSuite; + export type Response = + | Vapi.SimulationRunListItemSimulationsItem.Simulation + | Vapi.SimulationRunListItemSimulationsItem.SimulationSuite; +} diff --git a/src/api/types/SimulationRunListItemStatus.ts b/src/api/types/SimulationRunListItemStatus.ts new file mode 100644 index 00000000..3f93670a --- /dev/null +++ b/src/api/types/SimulationRunListItemStatus.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Current status of the run */ +export const SimulationRunListItemStatus = { + Queued: "queued", + Running: "running", + Ended: "ended", +} as const; +export type SimulationRunListItemStatus = + (typeof SimulationRunListItemStatus)[keyof typeof SimulationRunListItemStatus]; diff --git a/src/api/types/SimulationRunListItemTarget.ts b/src/api/types/SimulationRunListItemTarget.ts new file mode 100644 index 00000000..83c09062 --- /dev/null +++ b/src/api/types/SimulationRunListItemTarget.ts @@ -0,0 +1,25 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * Target to test against + */ +export type SimulationRunListItemTarget = + | Vapi.SimulationRunListItemTarget.Assistant + | Vapi.SimulationRunListItemTarget.Squad; + +export namespace SimulationRunListItemTarget { + export interface Assistant extends Vapi.SimulationRunTargetAssistant { + type: "assistant"; + } + + export interface Squad extends Vapi.SimulationRunTargetSquad { + type: "squad"; + } + + /** + * Target to test against + */ + export type Response = Vapi.SimulationRunListItemTarget.Assistant | Vapi.SimulationRunListItemTarget.Squad; +} diff --git a/src/api/types/SimulationRunListSource.ts b/src/api/types/SimulationRunListSource.ts new file mode 100644 index 00000000..33fc6ac2 --- /dev/null +++ b/src/api/types/SimulationRunListSource.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationRunListSource { + type: Vapi.SimulationRunListSourceType; + id?: string | undefined; + name: string; + linkable: boolean; + simulationIds: string[]; +} diff --git a/src/api/types/SimulationRunListSourceType.ts b/src/api/types/SimulationRunListSourceType.ts new file mode 100644 index 00000000..4c1c9a5f --- /dev/null +++ b/src/api/types/SimulationRunListSourceType.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunListSourceType = { + Suite: "suite", + Simulation: "simulation", + AdHoc: "adHoc", + Api: "api", +} as const; +export type SimulationRunListSourceType = + (typeof SimulationRunListSourceType)[keyof typeof SimulationRunListSourceType]; diff --git a/src/api/types/SimulationRunListSummary.ts b/src/api/types/SimulationRunListSummary.ts new file mode 100644 index 00000000..f2207ee3 --- /dev/null +++ b/src/api/types/SimulationRunListSummary.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationRunListSummary { + source: Vapi.SimulationRunListSource; + targetSnapshotName?: string | undefined; + simulationCount: number; +} diff --git a/src/api/types/SimulationRunPaymentRequiredResponse.ts b/src/api/types/SimulationRunPaymentRequiredResponse.ts new file mode 100644 index 00000000..d777a396 --- /dev/null +++ b/src/api/types/SimulationRunPaymentRequiredResponse.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationRunPaymentRequiredResponse { + statusCode: number; + message: string; + reason: Vapi.SimulationRunPaymentRequiredResponseReason; +} diff --git a/src/api/types/SimulationRunPaymentRequiredResponseReason.ts b/src/api/types/SimulationRunPaymentRequiredResponseReason.ts new file mode 100644 index 00000000..22076e29 --- /dev/null +++ b/src/api/types/SimulationRunPaymentRequiredResponseReason.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SimulationRunPaymentRequiredResponseReason = { + WalletMissing: "wallet_missing", + SubscriptionFrozen: "subscription_frozen", + PaymentMethodMissing: "payment_method_missing", + InsufficientCredits: "insufficient_credits", + BillingLimit: "billing_limit", + InitialPaymentMissing: "initial_payment_missing", +} as const; +export type SimulationRunPaymentRequiredResponseReason = + (typeof SimulationRunPaymentRequiredResponseReason)[keyof typeof SimulationRunPaymentRequiredResponseReason]; diff --git a/src/api/types/SimulationRunSimulationsItem.ts b/src/api/types/SimulationRunSimulationsItem.ts index c1c06c9d..acbdb253 100644 --- a/src/api/types/SimulationRunSimulationsItem.ts +++ b/src/api/types/SimulationRunSimulationsItem.ts @@ -14,4 +14,11 @@ export namespace SimulationRunSimulationsItem { export interface SimulationSuite extends Vapi.SimulationRunSuiteEntry { type: "simulationSuite"; } + + export type Request = + | Vapi.SimulationRunSimulationsItem.Simulation + | Vapi.SimulationRunSimulationsItem.SimulationSuite; + export type Response = + | Vapi.SimulationRunSimulationsItem.Simulation + | Vapi.SimulationRunSimulationsItem.SimulationSuite; } diff --git a/src/api/types/SimulationRunStatus.ts b/src/api/types/SimulationRunStatus.ts index fa97e30b..23cb6ff0 100644 --- a/src/api/types/SimulationRunStatus.ts +++ b/src/api/types/SimulationRunStatus.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** Current status of the run */ +/** The run's current status. One of `queued`, `running`, or `ended`. */ export const SimulationRunStatus = { Queued: "queued", Running: "running", diff --git a/src/api/types/SimulationRunSuiteEntry.ts b/src/api/types/SimulationRunSuiteEntry.ts index ab3cdb36..0d218fa6 100644 --- a/src/api/types/SimulationRunSuiteEntry.ts +++ b/src/api/types/SimulationRunSuiteEntry.ts @@ -3,5 +3,7 @@ export interface SimulationRunSuiteEntry { /** ID of the simulation suite to run */ simulationSuiteId?: string | undefined; + /** Historical suite name captured when the run was created */ + name?: string | undefined; suiteId?: string | undefined; } diff --git a/src/api/types/SimulationRunTarget.ts b/src/api/types/SimulationRunTarget.ts index 6b7b5602..f8f7284f 100644 --- a/src/api/types/SimulationRunTarget.ts +++ b/src/api/types/SimulationRunTarget.ts @@ -3,7 +3,7 @@ import type * as Vapi from "../index.js"; /** - * Target to test against + * The assistant or squad the run was tested against. */ export type SimulationRunTarget = Vapi.SimulationRunTarget.Assistant | Vapi.SimulationRunTarget.Squad; @@ -15,4 +15,9 @@ export namespace SimulationRunTarget { export interface Squad extends Vapi.SimulationRunTargetSquad { type: "squad"; } + + /** + * The assistant or squad the run was tested against. + */ + export type Response = Vapi.SimulationRunTarget.Assistant | Vapi.SimulationRunTarget.Squad; } diff --git a/src/api/types/SimulationRunsPaginatedResponse.ts b/src/api/types/SimulationRunsPaginatedResponse.ts new file mode 100644 index 00000000..27c16ae9 --- /dev/null +++ b/src/api/types/SimulationRunsPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationRunsPaginatedResponse { + results: Vapi.SimulationRunListItem[]; + metadata: Vapi.PaginationMeta; +} diff --git a/src/api/types/SimulationSuite.ts b/src/api/types/SimulationSuite.ts index fc3427b8..74a2e45e 100644 --- a/src/api/types/SimulationSuite.ts +++ b/src/api/types/SimulationSuite.ts @@ -1,5 +1,7 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface SimulationSuite { /** This is the unique identifier for the simulation suite. */ id: string; @@ -21,4 +23,6 @@ export interface SimulationSuite { path?: (string | null) | undefined; /** This is the list of simulation IDs in this suite. */ simulationIds: string[]; + /** This is the ordered list of assistant or squad assignments for the suite. */ + targetAssignments: Vapi.SimulationSuiteTargetAssignment[]; } diff --git a/src/api/types/SimulationSuiteTargetAssignment.ts b/src/api/types/SimulationSuiteTargetAssignment.ts new file mode 100644 index 00000000..393c1afa --- /dev/null +++ b/src/api/types/SimulationSuiteTargetAssignment.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SimulationSuiteTargetAssignment { + /** This is the type of target assigned to the simulation suite. */ + targetType: Vapi.SimulationSuiteTargetAssignmentTargetType; + /** This is the unique identifier of the assigned assistant or squad. */ + targetId: string; +} diff --git a/src/api/types/SimulationSuiteTargetAssignmentTargetType.ts b/src/api/types/SimulationSuiteTargetAssignmentTargetType.ts new file mode 100644 index 00000000..8e6d6dda --- /dev/null +++ b/src/api/types/SimulationSuiteTargetAssignmentTargetType.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of target assigned to the simulation suite. */ +export const SimulationSuiteTargetAssignmentTargetType = { + Assistant: "assistant", + Squad: "squad", +} as const; +export type SimulationSuiteTargetAssignmentTargetType = + (typeof SimulationSuiteTargetAssignmentTargetType)[keyof typeof SimulationSuiteTargetAssignmentTargetType]; diff --git a/src/api/types/SipAuthentication.ts b/src/api/types/SipAuthentication.ts index 545f75e0..a4aa2301 100644 --- a/src/api/types/SipAuthentication.ts +++ b/src/api/types/SipAuthentication.ts @@ -1,7 +1,10 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Realm, username, and password used to authenticate SIP requests. + */ export interface SipAuthentication { - /** This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.vapi.ai. */ + /** This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to the SIP realm of the Vapi region serving the request (e.g. `sip.vapi.ai` for US, `sip.eu.vapi.ai` for EU). */ realm?: string | undefined; /** This will be expected in the `username` field of the `authorization` header of the SIP INVITE. */ username: string; diff --git a/src/api/types/SipRequestTool.ts b/src/api/types/SipRequestTool.ts index 7e57dacf..2f53dbcc 100644 --- a/src/api/types/SipRequestTool.ts +++ b/src/api/types/SipRequestTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ export interface SipRequestTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.SipRequestToolMessagesItem[] | undefined; /** The SIP method to send. */ verb: Vapi.SipRequestToolVerb; diff --git a/src/api/types/SipTrunkGateway.ts b/src/api/types/SipTrunkGateway.ts index 4059859c..8a4a4269 100644 --- a/src/api/types/SipTrunkGateway.ts +++ b/src/api/types/SipTrunkGateway.ts @@ -2,8 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Network and routing settings for a SIP trunk gateway, including address, port, netmask, inbound and outbound use, signaling protocol, and OPTIONS health checks. + */ export interface SipTrunkGateway { - /** This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com. */ + /** This is the address of the gateway. Inbound gateways require an IPv4 address like 1.1.1.1. Outbound-only gateways can also use a fully qualified domain name like my-sip-trunk.pstn.twilio.com. */ ip: string; /** * This is the port number of the gateway. Default is 5060. diff --git a/src/api/types/SipTrunkOutboundAuthenticationPlan.ts b/src/api/types/SipTrunkOutboundAuthenticationPlan.ts index 4eeb6bfd..931c1107 100644 --- a/src/api/types/SipTrunkOutboundAuthenticationPlan.ts +++ b/src/api/types/SipTrunkOutboundAuthenticationPlan.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk. + */ export interface SipTrunkOutboundAuthenticationPlan { /** This is not returned in the API. */ authPassword?: string | undefined; + /** Username used to authenticate outbound SIP requests. */ authUsername?: string | undefined; /** This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted. */ sipRegisterPlan?: Vapi.SipTrunkOutboundSipRegisterPlan | undefined; diff --git a/src/api/types/SipTrunkOutboundSipRegisterPlan.ts b/src/api/types/SipTrunkOutboundSipRegisterPlan.ts index a72e2f90..23f35481 100644 --- a/src/api/types/SipTrunkOutboundSipRegisterPlan.ts +++ b/src/api/types/SipTrunkOutboundSipRegisterPlan.ts @@ -1,7 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Registration settings used when the SIP trunk requires SIP REGISTER. + */ export interface SipTrunkOutboundSipRegisterPlan { + /** SIP registrar domain used for registration. */ domain?: string | undefined; + /** Username sent with the SIP REGISTER request. */ username?: string | undefined; + /** Authentication realm used for SIP registration. */ realm?: string | undefined; } diff --git a/src/api/types/SkippedStructuredOutput.ts b/src/api/types/SkippedStructuredOutput.ts new file mode 100644 index 00000000..6495317a --- /dev/null +++ b/src/api/types/SkippedStructuredOutput.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface SkippedStructuredOutput { + /** This is the name of the structured output that was skipped. */ + name: string; + /** + * This is the first condition that was not met. Conditions use AND semantics, so + * evaluation stops as soon as one condition does not pass. + */ + unmetCondition: Vapi.SkippedStructuredOutputUnmetCondition; +} diff --git a/src/api/types/SkippedStructuredOutputUnmetCondition.ts b/src/api/types/SkippedStructuredOutputUnmetCondition.ts new file mode 100644 index 00000000..54492b6c --- /dev/null +++ b/src/api/types/SkippedStructuredOutputUnmetCondition.ts @@ -0,0 +1,26 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the first condition that was not met. Conditions use AND semantics, so + * evaluation stops as soon as one condition does not pass. + */ +export type SkippedStructuredOutputUnmetCondition = + | Vapi.SkippedStructuredOutputUnmetCondition.MinMessages + | Vapi.SkippedStructuredOutputUnmetCondition.MinCallDuration + | Vapi.SkippedStructuredOutputUnmetCondition.EndedReason; + +export namespace SkippedStructuredOutputUnmetCondition { + export interface MinMessages extends Vapi.MinMessagesCondition { + type: "minMessages"; + } + + export interface MinCallDuration extends Vapi.MinCallDurationCondition { + type: "minCallDuration"; + } + + export interface EndedReason extends Vapi.EndedReasonCondition { + type: "endedReason"; + } +} diff --git a/src/api/types/SlackSendMessageTool.ts b/src/api/types/SlackSendMessageTool.ts index 42476133..a899e3e0 100644 --- a/src/api/types/SlackSendMessageTool.ts +++ b/src/api/types/SlackSendMessageTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send a message to Slack. + */ export interface SlackSendMessageTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.SlackSendMessageToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/SmallestAiVoice.ts b/src/api/types/SmallestAiVoice.ts index 81ae1495..274d6ec7 100644 --- a/src/api/types/SmallestAiVoice.ts +++ b/src/api/types/SmallestAiVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, caching, and fallback settings. + */ export interface SmallestAiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/SmartDenoisingPlan.ts b/src/api/types/SmartDenoisingPlan.ts index 3a0cfa4d..4f32740e 100644 --- a/src/api/types/SmartDenoisingPlan.ts +++ b/src/api/types/SmartDenoisingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether Krisp smart denoising filters background speech and noise. + */ export interface SmartDenoisingPlan { /** Whether smart denoising using Krisp is enabled. */ enabled?: boolean | undefined; diff --git a/src/api/types/SmsTool.ts b/src/api/types/SmsTool.ts index b07e3039..cb91c0aa 100644 --- a/src/api/types/SmsTool.ts +++ b/src/api/types/SmsTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that lets an assistant send an SMS message during a call. + */ export interface SmsTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.SmsToolMessagesItem[] | undefined; /** This is the unique identifier for the tool. */ id: string; diff --git a/src/api/types/SonioxContextGeneralItem.ts b/src/api/types/SonioxContextGeneralItem.ts new file mode 100644 index 00000000..d3770b90 --- /dev/null +++ b/src/api/types/SonioxContextGeneralItem.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface SonioxContextGeneralItem { + /** The key describing the type of context (e.g., "domain", "topic", "doctor", "organization"). */ + key: string; + /** The value for the context key (e.g., "Healthcare", "Diabetes management consultation"). */ + value: string; +} diff --git a/src/api/types/SonioxCredential.ts b/src/api/types/SonioxCredential.ts index 4edd54bc..486a2149 100644 --- a/src/api/types/SonioxCredential.ts +++ b/src/api/types/SonioxCredential.ts @@ -6,6 +6,8 @@ export interface SonioxCredential { provider: Vapi.SonioxCredentialProvider; /** This is not returned in the API. */ apiKey: string; + /** Custom Soniox WebSocket endpoint (e.g. EU server wss://stt-rt.eu.soniox.com/transcribe-websocket). Defaults to the region-appropriate endpoint when omitted. */ + apiUrl?: string | undefined; /** This is the unique identifier for the credential. */ id: string; /** This is the unique identifier for the org that this credential belongs to. */ diff --git a/src/api/types/SonioxTranscriber.ts b/src/api/types/SonioxTranscriber.ts index 464b6e49..42899674 100644 --- a/src/api/types/SonioxTranscriber.ts +++ b/src/api/types/SonioxTranscriber.ts @@ -2,17 +2,24 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Soniox, including model, language detection, endpointing, vocabulary, and fallback settings. + */ export interface SonioxTranscriber { /** The Soniox model to use for transcription. */ model?: Vapi.SonioxTranscriberModel | undefined; - /** The language for transcription. Uses ISO 639-1 codes. Soniox supports 60+ languages with a single universal model. */ + /** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). For multi-language hints or to enable Soniox auto-detect, use `languages` instead — when `languages` is set (including to an empty array), this field is ignored when building the Soniox request. Defaults to `en` if neither this nor `languages` is set. */ language?: Vapi.SonioxTranscriberLanguage | undefined; - /** When enabled, restricts transcription to the language specified in the language field. When disabled, the model can detect and transcribe any of 60+ supported languages. Defaults to true. */ + /** Language hints sent to Soniox as `language_hints`. Provide `[lang1, lang2, ...]` (ISO 639-1 codes) to bias recognition toward specific languages, or provide an explicit empty array `[]` to enable Soniox auto-detect across all 60+ supported languages. When set (including the empty array), this field takes precedence over the singular `language` field. When omitted, falls back to the singular `language` (which defaults to `en` if also unset). Best accuracy is achieved with a single language. */ + languages?: Vapi.SonioxTranscriberLanguagesItem[] | undefined; + /** When `true`, Soniox strictly restricts transcription to the languages in `languages` (or the singular `language` if `languages` is unset). When `false`, Soniox biases toward those languages but still allows transcription in other languages. Has no effect when no language hints are sent (e.g., `languages: []` for auto-detect). Defaults to `true` (strict mode). */ languageHintsStrict?: boolean | undefined; /** Maximum delay in milliseconds between when the speaker stops and when the endpoint is detected. Lower values mean faster turn-taking but more false endpoints. Range: 500-3000. Default: 500. */ maxEndpointDelayMs?: number | undefined; /** Custom vocabulary terms to boost recognition accuracy. Useful for brand names, product names, and domain-specific terminology. Maps to Soniox context.terms. */ customVocabulary?: string[] | undefined; + /** General context key-value pairs that guide the AI model during transcription. Helps adapt vocabulary to the correct domain, improving accuracy. Recommended: 10 or fewer pairs. Maps to Soniox context.general. */ + contextGeneral?: Vapi.SonioxContextGeneralItem[] | undefined; /** This is the plan for transcriber provider fallbacks in the event that the primary transcriber provider fails. */ fallbackPlan?: Vapi.FallbackTranscriberPlan | undefined; } diff --git a/src/api/types/SonioxTranscriberLanguage.ts b/src/api/types/SonioxTranscriberLanguage.ts index 2e5142e7..699eb83a 100644 --- a/src/api/types/SonioxTranscriberLanguage.ts +++ b/src/api/types/SonioxTranscriberLanguage.ts @@ -1,6 +1,6 @@ // This file was auto-generated by Fern from our API Definition. -/** The language for transcription. Uses ISO 639-1 codes. Soniox supports 60+ languages with a single universal model. */ +/** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). For multi-language hints or to enable Soniox auto-detect, use `languages` instead — when `languages` is set (including to an empty array), this field is ignored when building the Soniox request. Defaults to `en` if neither this nor `languages` is set. */ export const SonioxTranscriberLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/SonioxTranscriberLanguagesItem.ts b/src/api/types/SonioxTranscriberLanguagesItem.ts new file mode 100644 index 00000000..df4a4b8e --- /dev/null +++ b/src/api/types/SonioxTranscriberLanguagesItem.ts @@ -0,0 +1,191 @@ +// This file was auto-generated by Fern from our API Definition. + +export const SonioxTranscriberLanguagesItem = { + Aa: "aa", + Ab: "ab", + Ae: "ae", + Af: "af", + Ak: "ak", + Am: "am", + An: "an", + Ar: "ar", + As: "as", + Av: "av", + Ay: "ay", + Az: "az", + Ba: "ba", + Be: "be", + Bg: "bg", + Bh: "bh", + Bi: "bi", + Bm: "bm", + Bn: "bn", + Bo: "bo", + Br: "br", + Bs: "bs", + Ca: "ca", + Ce: "ce", + Ch: "ch", + Co: "co", + Cr: "cr", + Cs: "cs", + Cu: "cu", + Cv: "cv", + Cy: "cy", + Da: "da", + De: "de", + Dv: "dv", + Dz: "dz", + Ee: "ee", + El: "el", + En: "en", + Eo: "eo", + Es: "es", + Et: "et", + Eu: "eu", + Fa: "fa", + Ff: "ff", + Fi: "fi", + Fj: "fj", + Fo: "fo", + Fr: "fr", + Fy: "fy", + Ga: "ga", + Gd: "gd", + Gl: "gl", + Gn: "gn", + Gu: "gu", + Gv: "gv", + Ha: "ha", + He: "he", + Hi: "hi", + Ho: "ho", + Hr: "hr", + Ht: "ht", + Hu: "hu", + Hy: "hy", + Hz: "hz", + Ia: "ia", + Id: "id", + Ie: "ie", + Ig: "ig", + Ii: "ii", + Ik: "ik", + Io: "io", + Is: "is", + It: "it", + Iu: "iu", + Ja: "ja", + Jv: "jv", + Ka: "ka", + Kg: "kg", + Ki: "ki", + Kj: "kj", + Kk: "kk", + Kl: "kl", + Km: "km", + Kn: "kn", + Ko: "ko", + Kr: "kr", + Ks: "ks", + Ku: "ku", + Kv: "kv", + Kw: "kw", + Ky: "ky", + La: "la", + Lb: "lb", + Lg: "lg", + Li: "li", + Ln: "ln", + Lo: "lo", + Lt: "lt", + Lu: "lu", + Lv: "lv", + Mg: "mg", + Mh: "mh", + Mi: "mi", + Mk: "mk", + Ml: "ml", + Mn: "mn", + Mr: "mr", + Ms: "ms", + Mt: "mt", + My: "my", + Na: "na", + Nb: "nb", + Nd: "nd", + Ne: "ne", + Ng: "ng", + Nl: "nl", + Nn: "nn", + No: "no", + Nr: "nr", + Nv: "nv", + Ny: "ny", + Oc: "oc", + Oj: "oj", + Om: "om", + Or: "or", + Os: "os", + Pa: "pa", + Pi: "pi", + Pl: "pl", + Ps: "ps", + Pt: "pt", + Qu: "qu", + Rm: "rm", + Rn: "rn", + Ro: "ro", + Ru: "ru", + Rw: "rw", + Sa: "sa", + Sc: "sc", + Sd: "sd", + Se: "se", + Sg: "sg", + Si: "si", + Sk: "sk", + Sl: "sl", + Sm: "sm", + Sn: "sn", + So: "so", + Sq: "sq", + Sr: "sr", + Ss: "ss", + St: "st", + Su: "su", + Sv: "sv", + Sw: "sw", + Ta: "ta", + Te: "te", + Tg: "tg", + Th: "th", + Ti: "ti", + Tk: "tk", + Tl: "tl", + Tn: "tn", + To: "to", + Tr: "tr", + Ts: "ts", + Tt: "tt", + Tw: "tw", + Ty: "ty", + Ug: "ug", + Uk: "uk", + Ur: "ur", + Uz: "uz", + Ve: "ve", + Vi: "vi", + Vo: "vo", + Wa: "wa", + Wo: "wo", + Xh: "xh", + Yi: "yi", + Yue: "yue", + Yo: "yo", + Za: "za", + Zh: "zh", + Zu: "zu", +} as const; +export type SonioxTranscriberLanguagesItem = + (typeof SonioxTranscriberLanguagesItem)[keyof typeof SonioxTranscriberLanguagesItem]; diff --git a/src/api/types/SonioxTranscriberModel.ts b/src/api/types/SonioxTranscriberModel.ts index 5f6e2cc4..cff3d9f6 100644 --- a/src/api/types/SonioxTranscriberModel.ts +++ b/src/api/types/SonioxTranscriberModel.ts @@ -3,5 +3,6 @@ /** The Soniox model to use for transcription. */ export const SonioxTranscriberModel = { SttRtV4: "stt-rt-v4", + SttRtV5: "stt-rt-v5", } as const; export type SonioxTranscriberModel = (typeof SonioxTranscriberModel)[keyof typeof SonioxTranscriberModel]; diff --git a/src/api/types/SpeechmaticsCustomVocabularyItem.ts b/src/api/types/SpeechmaticsCustomVocabularyItem.ts index f132f331..f1e98032 100644 --- a/src/api/types/SpeechmaticsCustomVocabularyItem.ts +++ b/src/api/types/SpeechmaticsCustomVocabularyItem.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives. + */ export interface SpeechmaticsCustomVocabularyItem { /** The word or phrase to add to the custom vocabulary. */ content: string; diff --git a/src/api/types/SpeechmaticsTranscriber.ts b/src/api/types/SpeechmaticsTranscriber.ts index d7d1da9d..9c906cd0 100644 --- a/src/api/types/SpeechmaticsTranscriber.ts +++ b/src/api/types/SpeechmaticsTranscriber.ts @@ -2,9 +2,13 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Speechmatics, including language, region, diarization, vocabulary, endpointing, formatting, and fallback settings. + */ export interface SpeechmaticsTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.SpeechmaticsTranscriberModel | undefined; + /** Language used for transcription. Set to `auto` to detect the language automatically. */ language?: Vapi.SpeechmaticsTranscriberLanguage | undefined; /** * This is the operating point for the transcription. Choose between `standard` for faster turnaround with strong accuracy or `enhanced` for highest accuracy when precision is critical. @@ -30,6 +34,7 @@ export interface SpeechmaticsTranscriber { * @default 3000 */ maxDelay?: number | undefined; + /** Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ customVocabulary: Vapi.SpeechmaticsCustomVocabularyItem[]; /** * This controls how numbers, dates, currencies, and other entities are formatted in the transcription output. diff --git a/src/api/types/SpeechmaticsTranscriberLanguage.ts b/src/api/types/SpeechmaticsTranscriberLanguage.ts index 63fc6621..0f0e071d 100644 --- a/src/api/types/SpeechmaticsTranscriberLanguage.ts +++ b/src/api/types/SpeechmaticsTranscriberLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language used for transcription. Set to `auto` to detect the language automatically. */ export const SpeechmaticsTranscriberLanguage = { Auto: "auto", Ar: "ar", diff --git a/src/api/types/SpkiPemPublicKeyConfig.ts b/src/api/types/SpkiPemPublicKeyConfig.ts index 02fa9e30..31021b71 100644 --- a/src/api/types/SpkiPemPublicKeyConfig.ts +++ b/src/api/types/SpkiPemPublicKeyConfig.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An SPKI public key in PEM format used to encrypt sensitive request data. + */ export interface SpkiPemPublicKeyConfig { /** Optional name of the key for identification purposes. */ name?: string | undefined; diff --git a/src/api/types/SqlInjectionSecurityFilter.ts b/src/api/types/SqlInjectionSecurityFilter.ts index ea36522d..ff250ffa 100644 --- a/src/api/types/SqlInjectionSecurityFilter.ts +++ b/src/api/types/SqlInjectionSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential SQL injection patterns from transcripts. + */ export interface SqlInjectionSecurityFilter { /** The type of security threat to filter. */ type: Vapi.SqlInjectionSecurityFilterType; diff --git a/src/api/types/Squad.ts b/src/api/types/Squad.ts index 7f8c7ae3..0df83e44 100644 --- a/src/api/types/Squad.ts +++ b/src/api/types/Squad.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved squad configuration that coordinates a group of assistants during a conversation. The first member starts the call, and member destinations control transfers between assistants. + */ export interface Squad { /** This is the name of the squad. */ name?: string | undefined; diff --git a/src/api/types/SquadMemberDto.ts b/src/api/types/SquadMemberDto.ts index 4052e063..8caacff7 100644 --- a/src/api/types/SquadMemberDto.ts +++ b/src/api/types/SquadMemberDto.ts @@ -2,7 +2,17 @@ import type * as Vapi from "../index.js"; +/** + * An assistant member of a squad. Reference a saved assistant or provide a transient assistant, then configure member-specific overrides and destinations for transfers. + */ export interface SquadMemberDto { + /** + * This is the assistant version (e.g. `v3`) to pin for this squad member. When set, the call uses + * the snapshot from `assistant_version` (by `(assistantId, version)`) instead of the latest. Valid + * only with `assistantId`; rejected with inline `assistant`. Omit to follow the latest version. + */ + assistantVersion?: (string | null) | undefined; + /** Assistants this squad member can route the conversation to through a transfer or handoff. */ assistantDestinations?: Vapi.SquadMemberDtoAssistantDestinationsItem[] | undefined; /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */ assistantId?: (string | null) | undefined; diff --git a/src/api/types/SsrfSecurityFilter.ts b/src/api/types/SsrfSecurityFilter.ts index bb371911..38d85c33 100644 --- a/src/api/types/SsrfSecurityFilter.ts +++ b/src/api/types/SsrfSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential server-side request forgery (SSRF) patterns from transcripts. + */ export interface SsrfSecurityFilter { /** The type of security threat to filter. */ type: Vapi.SsrfSecurityFilterType; diff --git a/src/api/types/StartSpeakingPlan.ts b/src/api/types/StartSpeakingPlan.ts index 99a80253..170b4770 100644 --- a/src/api/types/StartSpeakingPlan.ts +++ b/src/api/types/StartSpeakingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing strategy, and custom endpointing rules. + */ export interface StartSpeakingPlan { /** * This is how long assistant waits before speaking. Defaults to 0.4. diff --git a/src/api/types/StopSpeakingPlan.ts b/src/api/types/StopSpeakingPlan.ts index 32984c52..8ee193f7 100644 --- a/src/api/types/StopSpeakingPlan.ts +++ b/src/api/types/StopSpeakingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, restart delay, and phrase exceptions. + */ export interface StopSpeakingPlan { /** * This is the number of words that the customer has to say before the assistant will stop talking. diff --git a/src/api/types/StructuredDataMultiPlan.ts b/src/api/types/StructuredDataMultiPlan.ts index 213da004..196ebbad 100644 --- a/src/api/types/StructuredDataMultiPlan.ts +++ b/src/api/types/StructuredDataMultiPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Associates a catalog key with a structured data extraction plan. + */ export interface StructuredDataMultiPlan { /** This is the key of the structured data plan in the catalog. */ key: string; diff --git a/src/api/types/StructuredDataPlan.ts b/src/api/types/StructuredDataPlan.ts index 35a304a5..572b12e6 100644 --- a/src/api/types/StructuredDataPlan.ts +++ b/src/api/types/StructuredDataPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request timeout. + */ export interface StructuredDataPlan { /** * These are the messages used to generate the structured data. diff --git a/src/api/types/StructuredOutput.ts b/src/api/types/StructuredOutput.ts index 7b38a604..70465476 100644 --- a/src/api/types/StructuredOutput.ts +++ b/src/api/types/StructuredOutput.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved structured-output definition containing its extraction schema, execution method, model or regular expression, linked resources, and lifecycle metadata. + */ export interface StructuredOutput { /** * This is the type of structured output. @@ -41,6 +44,8 @@ export interface StructuredOutput { model?: Vapi.StructuredOutputModel | undefined; /** Compliance configuration for this output. Only enable overrides if no sensitive data will be stored. */ compliancePlan?: Vapi.ComplianceOverride | undefined; + /** These are the conditions that gate the execution of this structured output. Every condition must pass for the structured output to run (AND semantics). When omitted or empty, no user-defined conditions gate this output. Send null to clear a previously saved gate. */ + conditions?: (Vapi.StructuredOutputConditionsItem[] | null) | undefined; /** This is the unique identifier for the structured output. */ id: string; /** This is the unique identifier for the org that this structured output belongs to. */ diff --git a/src/api/types/StructuredOutputConditionsItem.ts b/src/api/types/StructuredOutputConditionsItem.ts new file mode 100644 index 00000000..0ace6b55 --- /dev/null +++ b/src/api/types/StructuredOutputConditionsItem.ts @@ -0,0 +1,22 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type StructuredOutputConditionsItem = + | Vapi.StructuredOutputConditionsItem.MinMessages + | Vapi.StructuredOutputConditionsItem.MinCallDuration + | Vapi.StructuredOutputConditionsItem.EndedReason; + +export namespace StructuredOutputConditionsItem { + export interface MinMessages extends Vapi.MinMessagesCondition { + type: "minMessages"; + } + + export interface MinCallDuration extends Vapi.MinCallDurationCondition { + type: "minCallDuration"; + } + + export interface EndedReason extends Vapi.EndedReasonCondition { + type: "endedReason"; + } +} diff --git a/src/api/types/StructuredOutputCostBreakdown.ts b/src/api/types/StructuredOutputCostBreakdown.ts new file mode 100644 index 00000000..60fcb9ca --- /dev/null +++ b/src/api/types/StructuredOutputCostBreakdown.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface StructuredOutputCostBreakdown { + /** This is the unique identifier of the structured output that produced this cost. */ + structuredOutputId: string; + /** This is the name of the structured output, so this breakdown is readable without looking the id up. */ + name: string; + /** This is the cost in USD of evaluating this structured output. */ + cost: number; + /** This is the number of prompt tokens used to evaluate this structured output. */ + promptTokens: number; + /** This is the number of completion tokens generated for this structured output. */ + completionTokens: number; + /** This is the number of cached prompt tokens used to evaluate this structured output. This is a subset of `promptTokens`, not an addition to it. */ + cachedPromptTokens?: number | undefined; +} diff --git a/src/api/types/StructuredOutputEvaluationResult.ts b/src/api/types/StructuredOutputEvaluationResult.ts index fb3f2335..141e6271 100644 --- a/src/api/types/StructuredOutputEvaluationResult.ts +++ b/src/api/types/StructuredOutputEvaluationResult.ts @@ -10,6 +10,12 @@ export interface StructuredOutputEvaluationResult { structuredOutputId: string; /** This is the name of the structured output. */ name: string; + /** This is the optional dot-notation path evaluated within an object structured output. */ + path?: string | undefined; + /** This is the structured output description captured when the evaluation ran. */ + description?: string | undefined; + /** This is the structured output schema captured when the evaluation ran. */ + schema?: Vapi.JsonSchema | undefined; /** This is the value extracted from the call by the structured output. */ extractedValue: Vapi.StructuredOutputEvaluationResultExtractedValue | null; /** This is the expected value that was defined in the evaluation plan. */ diff --git a/src/api/types/StructuredOutputPaginatedResponse.ts b/src/api/types/StructuredOutputPaginatedResponse.ts index 7ac44137..a3afd70d 100644 --- a/src/api/types/StructuredOutputPaginatedResponse.ts +++ b/src/api/types/StructuredOutputPaginatedResponse.ts @@ -2,7 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A paginated collection of structured-output definitions and metadata describing the result set. + */ export interface StructuredOutputPaginatedResponse { + /** The structured-output definitions returned for the current page. */ results: Vapi.StructuredOutput[]; + /** Pagination metadata for the structured-output result set. */ metadata: Vapi.PaginationMeta; } diff --git a/src/api/types/StructuredOutputRerunResponse.ts b/src/api/types/StructuredOutputRerunResponse.ts new file mode 100644 index 00000000..9f2c0b64 --- /dev/null +++ b/src/api/types/StructuredOutputRerunResponse.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface StructuredOutputRerunResponse { + /** This is the id of the workflow processing the rerun. */ + workflowId?: string | undefined; + message: string; +} diff --git a/src/api/types/StructuredOutputRunPreviewResponse.ts b/src/api/types/StructuredOutputRunPreviewResponse.ts new file mode 100644 index 00000000..fa50f068 --- /dev/null +++ b/src/api/types/StructuredOutputRunPreviewResponse.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface StructuredOutputRunPreviewResponse { + /** + * These are the structured outputs whose conditions gated them, keyed by + * structured output id. Absent when nothing was skipped. An entry here means + * no extraction ran and no cost was incurred for that output. + */ + skipped?: Record | undefined; +} diff --git a/src/api/types/StructuredOutputRunResult.ts b/src/api/types/StructuredOutputRunResult.ts new file mode 100644 index 00000000..0431608a --- /dev/null +++ b/src/api/types/StructuredOutputRunResult.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface StructuredOutputRunResult { + /** This is the name of the structured output that produced this value. */ + name: string; + /** This is the extracted value, shaped by the structured output's schema. */ + result: Vapi.StructuredOutputRunResultResult | null; + compliancePlan?: Vapi.ComplianceOverride | undefined; +} diff --git a/src/api/types/StructuredOutputRunResultResult.ts b/src/api/types/StructuredOutputRunResultResult.ts new file mode 100644 index 00000000..d4078a06 --- /dev/null +++ b/src/api/types/StructuredOutputRunResultResult.ts @@ -0,0 +1,6 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the extracted value, shaped by the structured output's schema. + */ +export type StructuredOutputRunResultResult = string | number | boolean | Record | unknown[]; diff --git a/src/api/types/Subscription.ts b/src/api/types/Subscription.ts index a2adb5c7..51e6356a 100644 --- a/src/api/types/Subscription.ts +++ b/src/api/types/Subscription.ts @@ -105,9 +105,9 @@ export interface Subscription { /** This is the ID for the Common Paper agreement outlining the PCI contract. */ pciCommonPaperAgreementId?: string | undefined; /** This is the call retention days for the subscription. */ - callRetentionDays?: number | undefined; + callRetentionDays?: (number | null) | undefined; /** This is the chat retention days for the subscription. */ - chatRetentionDays?: number | undefined; + chatRetentionDays?: (number | null) | undefined; /** This is the minutes_included reset frequency for the subscription. */ minutesIncludedResetFrequency?: Vapi.SubscriptionMinutesIncludedResetFrequency | undefined; /** This is the Role Based Access Control (RBAC) enabled flag for the subscription. */ diff --git a/src/api/types/SubscriptionLimits.ts b/src/api/types/SubscriptionLimits.ts index 4198f818..fecc8a04 100644 --- a/src/api/types/SubscriptionLimits.ts +++ b/src/api/types/SubscriptionLimits.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Organization concurrency limits and remaining concurrent call capacity. + */ export interface SubscriptionLimits { /** True if this call was blocked by the Call Concurrency limit */ concurrencyBlocked?: boolean | undefined; diff --git a/src/api/types/SuccessEvaluationPlan.ts b/src/api/types/SuccessEvaluationPlan.ts index 49f5bea2..f752966e 100644 --- a/src/api/types/SuccessEvaluationPlan.ts +++ b/src/api/types/SuccessEvaluationPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout. + */ export interface SuccessEvaluationPlan { /** * This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`. diff --git a/src/api/types/SummaryPlan.ts b/src/api/types/SummaryPlan.ts index 7572f558..19698ff8 100644 --- a/src/api/types/SummaryPlan.ts +++ b/src/api/types/SummaryPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls generation of a post-call summary, including prompt messages, enablement, and request timeout. + */ export interface SummaryPlan { /** * These are the messages used to generate the summary. diff --git a/src/api/types/SupabaseBucketPlan.ts b/src/api/types/SupabaseBucketPlan.ts index e53f8345..55e847fa 100644 --- a/src/api/types/SupabaseBucketPlan.ts +++ b/src/api/types/SupabaseBucketPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket name, and path. + */ export interface SupabaseBucketPlan { /** * This is the S3 Region. It should look like us-east-1 diff --git a/src/api/types/SyncVoiceLibraryDtoProvidersItem.ts b/src/api/types/SyncVoiceLibraryDtoProvidersItem.ts index f548aebf..b407dcc2 100644 --- a/src/api/types/SyncVoiceLibraryDtoProvidersItem.ts +++ b/src/api/types/SyncVoiceLibraryDtoProvidersItem.ts @@ -20,6 +20,8 @@ export const SyncVoiceLibraryDtoProvidersItem = { Minimax: "minimax", Wellsaid: "wellsaid", Orpheus: "orpheus", + Xai: "xai", + Microsoft: "microsoft", } as const; export type SyncVoiceLibraryDtoProvidersItem = (typeof SyncVoiceLibraryDtoProvidersItem)[keyof typeof SyncVoiceLibraryDtoProvidersItem]; diff --git a/src/api/types/SystemMessage.ts b/src/api/types/SystemMessage.ts index 08903393..cc5acb78 100644 --- a/src/api/types/SystemMessage.ts +++ b/src/api/types/SystemMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A system-authored entry in the call message history, including its content and timing. + */ export interface SystemMessage { /** The role of the system in the conversation. */ role: string; diff --git a/src/api/types/TalkscriberTranscriber.ts b/src/api/types/TalkscriberTranscriber.ts index d7f7c629..5897c46e 100644 --- a/src/api/types/TalkscriberTranscriber.ts +++ b/src/api/types/TalkscriberTranscriber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, and fallback settings. + */ export interface TalkscriberTranscriber { /** This is the model that will be used for the transcription. */ model?: Vapi.TalkscriberTranscriberModel | undefined; diff --git a/src/api/types/TavusConversationProperties.ts b/src/api/types/TavusConversationProperties.ts index 22d50bc3..03ad8c9e 100644 --- a/src/api/types/TavusConversationProperties.ts +++ b/src/api/types/TavusConversationProperties.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Tavus conversation behavior and media settings, including duration, participant timeouts, recording, transcription, background, language, and recording storage. + */ export interface TavusConversationProperties { /** * The maximum duration of the call in seconds. The default `maxCallDuration` is 3600 seconds (1 hour). diff --git a/src/api/types/TavusVoice.ts b/src/api/types/TavusVoice.ts index 32f5ae37..0a1d99d2 100644 --- a/src/api/types/TavusVoice.ts +++ b/src/api/types/TavusVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, caching, and fallback settings. + */ export interface TavusVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/TelnyxPhoneNumber.ts b/src/api/types/TelnyxPhoneNumber.ts index bc347fed..d442e4b3 100644 --- a/src/api/types/TelnyxPhoneNumber.ts +++ b/src/api/types/TelnyxPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface TelnyxPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/TelnyxTransport.ts b/src/api/types/TelnyxTransport.ts new file mode 100644 index 00000000..b7044c45 --- /dev/null +++ b/src/api/types/TelnyxTransport.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface TelnyxTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.TelnyxTransportConversationType | undefined; + /** This is the call control ID of the Telnyx call. */ + callControlId?: string | undefined; + /** This is the call leg ID of the Telnyx call. */ + callLegId?: string | undefined; + /** This is the call session ID of the Telnyx call. */ + callSessionId?: string | undefined; +} diff --git a/src/api/types/TelnyxTransportConversationType.ts b/src/api/types/TelnyxTransportConversationType.ts new file mode 100644 index 00000000..17e7a516 --- /dev/null +++ b/src/api/types/TelnyxTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const TelnyxTransportConversationType = { + Voice: "voice", +} as const; +export type TelnyxTransportConversationType = + (typeof TelnyxTransportConversationType)[keyof typeof TelnyxTransportConversationType]; diff --git a/src/api/types/TemplateDetails.ts b/src/api/types/TemplateDetails.ts index 69397803..d2f2c0cd 100644 --- a/src/api/types/TemplateDetails.ts +++ b/src/api/types/TemplateDetails.ts @@ -119,4 +119,29 @@ export namespace TemplateDetails { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.TemplateDetails.ApiRequest + | Vapi.TemplateDetails.Bash + | Vapi.TemplateDetails.Code + | Vapi.TemplateDetails.Computer + | Vapi.TemplateDetails.Dtmf + | Vapi.TemplateDetails.EndCall + | Vapi.TemplateDetails.Function + | Vapi.TemplateDetails.GohighlevelCalendarAvailabilityCheck + | Vapi.TemplateDetails.GohighlevelCalendarEventCreate + | Vapi.TemplateDetails.GohighlevelContactCreate + | Vapi.TemplateDetails.GohighlevelContactGet + | Vapi.TemplateDetails.GoogleCalendarAvailabilityCheck + | Vapi.TemplateDetails.GoogleCalendarEventCreate + | Vapi.TemplateDetails.GoogleSheetsRowAppend + | Vapi.TemplateDetails.Handoff + | Vapi.TemplateDetails.Mcp + | Vapi.TemplateDetails.Query + | Vapi.TemplateDetails.SlackMessageSend + | Vapi.TemplateDetails.Sms + | Vapi.TemplateDetails.TextEditor + | Vapi.TemplateDetails.TransferCall + | Vapi.TemplateDetails.SipRequest + | Vapi.TemplateDetails.Voicemail; } diff --git a/src/api/types/TextContent.ts b/src/api/types/TextContent.ts index 6a4f7bc1..8ddc3dd0 100644 --- a/src/api/types/TextContent.ts +++ b/src/api/types/TextContent.ts @@ -2,8 +2,14 @@ import type * as Vapi from "../index.js"; +/** + * Localized text content used as a language-specific message variant. + */ export interface TextContent { + /** Selects text as the content type. */ type: Vapi.TextContentType; + /** Text spoken or displayed for this content variant. */ text: string; + /** Language code associated with this text variant. */ language: Vapi.TextContentLanguage; } diff --git a/src/api/types/TextContentLanguage.ts b/src/api/types/TextContentLanguage.ts index 51352c70..07c23945 100644 --- a/src/api/types/TextContentLanguage.ts +++ b/src/api/types/TextContentLanguage.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Language code associated with this text variant. */ export const TextContentLanguage = { Aa: "aa", Ab: "ab", diff --git a/src/api/types/TextContentType.ts b/src/api/types/TextContentType.ts index 55c03733..1366072b 100644 --- a/src/api/types/TextContentType.ts +++ b/src/api/types/TextContentType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects text as the content type. */ export const TextContentType = { Text: "text", } as const; diff --git a/src/api/types/TextEditorTool.ts b/src/api/types/TextEditorTool.ts index 383b77f9..489f7a48 100644 --- a/src/api/types/TextEditorTool.ts +++ b/src/api/types/TextEditorTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that reads and edits text files in a configured environment. + */ export interface TextEditorTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.TextEditorToolMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.TextEditorToolSubType; diff --git a/src/api/types/TextEditorToolWithToolCall.ts b/src/api/types/TextEditorToolWithToolCall.ts index 7b61c5a9..113ec97b 100644 --- a/src/api/types/TextEditorToolWithToolCall.ts +++ b/src/api/types/TextEditorToolWithToolCall.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface TextEditorToolWithToolCall { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.TextEditorToolWithToolCallMessagesItem[] | undefined; /** The sub type of tool. */ subType: Vapi.TextEditorToolWithToolCallSubType; diff --git a/src/api/types/TextInsight.ts b/src/api/types/TextInsight.ts index deddceee..547fee94 100644 --- a/src/api/types/TextInsight.ts +++ b/src/api/types/TextInsight.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information. + */ export interface TextInsight { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface TextInsight { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. @@ -37,4 +41,6 @@ export interface TextInsight { createdAt: string; /** This is the ISO 8601 date-time string of when the Insight was last updated. */ updatedAt: string; + /** Stable server-owned identifier for system-created insights. */ + systemKey?: string | undefined; } diff --git a/src/api/types/TimeRange.ts b/src/api/types/TimeRange.ts index 21646bc4..0746d953 100644 --- a/src/api/types/TimeRange.ts +++ b/src/api/types/TimeRange.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Start, end, timezone, and time step used for analytics aggregation. + */ export interface TimeRange { /** * This is the time step for aggregations. diff --git a/src/api/types/TogetherAiModel.ts b/src/api/types/TogetherAiModel.ts index b3062449..38323a5d 100644 --- a/src/api/types/TogetherAiModel.ts +++ b/src/api/types/TogetherAiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface TogetherAiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface TogetherAiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/TogetherAiModelToolsItem.ts b/src/api/types/TogetherAiModelToolsItem.ts index 30db4442..4740b4dd 100644 --- a/src/api/types/TogetherAiModelToolsItem.ts +++ b/src/api/types/TogetherAiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace TogetherAiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.TogetherAiModelToolsItem.ApiRequest + | Vapi.TogetherAiModelToolsItem.Bash + | Vapi.TogetherAiModelToolsItem.Code + | Vapi.TogetherAiModelToolsItem.Computer + | Vapi.TogetherAiModelToolsItem.Dtmf + | Vapi.TogetherAiModelToolsItem.EndCall + | Vapi.TogetherAiModelToolsItem.Function + | Vapi.TogetherAiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.TogetherAiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.TogetherAiModelToolsItem.GohighlevelContactCreate + | Vapi.TogetherAiModelToolsItem.GohighlevelContactGet + | Vapi.TogetherAiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.TogetherAiModelToolsItem.GoogleCalendarEventCreate + | Vapi.TogetherAiModelToolsItem.GoogleSheetsRowAppend + | Vapi.TogetherAiModelToolsItem.Handoff + | Vapi.TogetherAiModelToolsItem.Mcp + | Vapi.TogetherAiModelToolsItem.Query + | Vapi.TogetherAiModelToolsItem.SlackMessageSend + | Vapi.TogetherAiModelToolsItem.Sms + | Vapi.TogetherAiModelToolsItem.TextEditor + | Vapi.TogetherAiModelToolsItem.TransferCall + | Vapi.TogetherAiModelToolsItem.SipRequest + | Vapi.TogetherAiModelToolsItem.Voicemail; } diff --git a/src/api/types/ToolCall.ts b/src/api/types/ToolCall.ts index e12999c6..f56b9aad 100644 --- a/src/api/types/ToolCall.ts +++ b/src/api/types/ToolCall.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A tool invocation requested by the assistant, including its identifier, type, and function details. + */ export interface ToolCall { /** This is the ID of the tool call */ id: string; diff --git a/src/api/types/ToolCallFunction.ts b/src/api/types/ToolCallFunction.ts index e1ef5e1f..b0faf2dc 100644 --- a/src/api/types/ToolCallFunction.ts +++ b/src/api/types/ToolCallFunction.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * The function name and serialized arguments associated with a tool call. + */ export interface ToolCallFunction { /** This is the arguments to call the function with */ arguments: string; diff --git a/src/api/types/ToolCallHookAction.ts b/src/api/types/ToolCallHookAction.ts index c6e345d3..e400b8be 100644 --- a/src/api/types/ToolCallHookAction.ts +++ b/src/api/types/ToolCallHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A hook action that invokes an inline tool or an existing tool when the hook triggers. + */ export interface ToolCallHookAction { /** This is the type of action - must be "tool" */ type: Vapi.ToolCallHookActionType; diff --git a/src/api/types/ToolCallHookActionTool.ts b/src/api/types/ToolCallHookActionTool.ts index e6d61617..65e40744 100644 --- a/src/api/types/ToolCallHookActionTool.ts +++ b/src/api/types/ToolCallHookActionTool.ts @@ -122,4 +122,32 @@ export namespace ToolCallHookActionTool { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + /** + * This is the tool to call. To use an existing tool, send `toolId` instead. + */ + export type Response = + | Vapi.ToolCallHookActionTool.ApiRequest + | Vapi.ToolCallHookActionTool.Bash + | Vapi.ToolCallHookActionTool.Code + | Vapi.ToolCallHookActionTool.Computer + | Vapi.ToolCallHookActionTool.Dtmf + | Vapi.ToolCallHookActionTool.EndCall + | Vapi.ToolCallHookActionTool.Function + | Vapi.ToolCallHookActionTool.GohighlevelCalendarAvailabilityCheck + | Vapi.ToolCallHookActionTool.GohighlevelCalendarEventCreate + | Vapi.ToolCallHookActionTool.GohighlevelContactCreate + | Vapi.ToolCallHookActionTool.GohighlevelContactGet + | Vapi.ToolCallHookActionTool.GoogleCalendarAvailabilityCheck + | Vapi.ToolCallHookActionTool.GoogleCalendarEventCreate + | Vapi.ToolCallHookActionTool.GoogleSheetsRowAppend + | Vapi.ToolCallHookActionTool.Handoff + | Vapi.ToolCallHookActionTool.Mcp + | Vapi.ToolCallHookActionTool.Query + | Vapi.ToolCallHookActionTool.SlackMessageSend + | Vapi.ToolCallHookActionTool.Sms + | Vapi.ToolCallHookActionTool.TextEditor + | Vapi.ToolCallHookActionTool.TransferCall + | Vapi.ToolCallHookActionTool.SipRequest + | Vapi.ToolCallHookActionTool.Voicemail; } diff --git a/src/api/types/ToolCallMessage.ts b/src/api/types/ToolCallMessage.ts index 1675f26c..5680dc99 100644 --- a/src/api/types/ToolCallMessage.ts +++ b/src/api/types/ToolCallMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * An entry in the call message history that records one or more tool calls requested during the conversation. + */ export interface ToolCallMessage { /** The role of the tool call in the conversation. */ role: string; diff --git a/src/api/types/ToolCallResultMessage.ts b/src/api/types/ToolCallResultMessage.ts index 2d25c063..5ff7927b 100644 --- a/src/api/types/ToolCallResultMessage.ts +++ b/src/api/types/ToolCallResultMessage.ts @@ -1,18 +1,24 @@ // This file was auto-generated by Fern from our API Definition. -export interface ToolCallResultMessage { - /** The role of the tool call result in the conversation. */ - role: string; - /** The ID of the tool call. */ - toolCallId: string; - /** The name of the tool that returned the result. */ - name: string; - /** The result of the tool call in JSON format. */ - result: string; - /** The timestamp when the message was sent. */ - time: number; - /** The number of seconds from the start of the conversation. */ - secondsFromStart: number; - /** The metadata for the tool call result. */ - metadata?: Record | undefined; +import type * as Vapi from "../index.js"; + +/** + * This is the message that will be spoken to the user. + * + * If this is not returned, assistant will speak: + * 1. a `request-complete` or `request-failed` message from `tool.messages`, if it exists + * 2. a response generated by the model, if not + */ +export type ToolCallResultMessage = + | Vapi.ToolCallResultMessage.RequestComplete + | Vapi.ToolCallResultMessage.RequestFailed; + +export namespace ToolCallResultMessage { + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } } diff --git a/src/api/types/ToolCallResultMessageWarning.ts b/src/api/types/ToolCallResultMessageWarning.ts new file mode 100644 index 00000000..e1559696 --- /dev/null +++ b/src/api/types/ToolCallResultMessageWarning.ts @@ -0,0 +1,17 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolCallResultMessageWarning { + /** + * The kind of warning. Currently: + * - `oversized-tool-response`: the tool's serialized response exceeded the + * recommended size and is likely to bloat the model context, increasing + * latency and risking truncation of earlier instructions. + */ + type: Vapi.ToolCallResultMessageWarningType; + /** The estimated number of tokens in the serialized tool response. */ + tokenCount: number; + /** The threshold (in tokens) above which the warning is raised. */ + threshold: number; +} diff --git a/src/api/types/ToolCallResultMessageWarningType.ts b/src/api/types/ToolCallResultMessageWarningType.ts new file mode 100644 index 00000000..64d2a281 --- /dev/null +++ b/src/api/types/ToolCallResultMessageWarningType.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * The kind of warning. Currently: + * - `oversized-tool-response`: the tool's serialized response exceeded the + * recommended size and is likely to bloat the model context, increasing + * latency and risking truncation of earlier instructions. + */ +export const ToolCallResultMessageWarningType = { + OversizedToolResponse: "oversized-tool-response", +} as const; +export type ToolCallResultMessageWarningType = + (typeof ToolCallResultMessageWarningType)[keyof typeof ToolCallResultMessageWarningType]; diff --git a/src/api/types/ToolDraft.ts b/src/api/types/ToolDraft.ts new file mode 100644 index 00000000..853a3235 --- /dev/null +++ b/src/api/types/ToolDraft.ts @@ -0,0 +1,179 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolDraft { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.ToolDraftMessagesItem[] | undefined; + /** This is the type of the tool. */ + type?: Vapi.ToolDraftType | undefined; + /** Key used as `draftId` in URLs. */ + id: string; + /** This is the unique identifier for the org that owns this draft. */ + orgId: string; + /** + * This is the unique identifier for the tool this draft was forked from. + * Intentionally NOT a FK — `tool_draft` mirrors `tool_version` / `version_pin`'s + * no-FK / app-cleanup philosophy, so there is no `ON DELETE CASCADE`. Drafts + * must be cleaned up explicitly (`toolDraftDelete({ orgId, toolId })`) on a + * parent tool hard-delete; nothing reaps them automatically. + */ + toolId: string; + /** + * The published version this draft was forked from. Server defaults to + * `tool.latestVersion` on POST if omitted. Immutable for the draft's lifetime. + */ + baseVersion: string; + /** Email when JWT, null when API or external JWT. Set on POST, never rewritten on PATCH. */ + createdBy?: (string | null) | undefined; + /** This is the ISO 8601 date-time string of when the draft was created. */ + createdAt: string; + /** This is the ISO 8601 date-time string of when the draft was last updated. */ + updatedAt: string; + /** + * This is the plan to reject a tool call based on the conversation state. + * + * // Example 1: Reject endCall if user didn't say goodbye + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', + * target: { position: -1, role: 'user' }, + * negate: true // Reject if pattern does NOT match + * }] + * } + * ``` + * + * // Example 2: Reject transfer if user is actually asking a question + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '\\?', + * target: { position: -1, role: 'user' } + * }] + * } + * ``` + * + * // Example 3: Reject transfer if user didn't mention transfer recently + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 5 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' %} + * {% assign mentioned = false %} + * {% for msg in userMessages %} + * {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} + * {% assign mentioned = true %} + * {% break %} + * {% endif %} + * {% endfor %} + * {% if mentioned %} + * false + * {% else %} + * true + * {% endif %}` + * }] + * } + * ``` + * + * // Example 4: Reject endCall if the bot is looping and trying to exit + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 6 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} + * {% if userMessages.size < 3 %} + * false + * {% else %} + * {% assign msg1 = userMessages[0].content | downcase %} + * {% assign msg2 = userMessages[1].content | downcase %} + * {% assign msg3 = userMessages[2].content | downcase %} + * {% comment %} Check for repetitive messages {% endcomment %} + * {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} + * true + * {% comment %} Check for common loop phrases {% endcomment %} + * {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} + * true + * {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} + * true + * {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} + * true + * {% else %} + * false + * {% endif %} + * {% endif %}` + * }] + * } + * ``` + */ + rejectionPlan?: Vapi.ToolRejectionPlan | undefined; + /** This is the function definition of the tool. */ + function?: Vapi.OpenAiFunction | undefined; + /** + * Provider-specific metadata. Polymorphic across tool variants with no shared + * discriminator, so it is validated as a plain object (mirrors how + * `ToolCallResult.metadata` is typed). + */ + metadata?: Record | undefined; + /** This is the unique identifier for the template this tool was created from. */ + templateId?: string | undefined; + server?: Vapi.Server | undefined; + async?: boolean | undefined; + /** These are the destinations that the call can be transferred to. */ + destinations?: Record[] | undefined; + /** This is the name of the tool. This will be passed to the model. */ + name?: string | undefined; + /** This is the sub type of the tool (e.g. for computer, bash and text-editor tools). */ + subType?: string | undefined; + /** The display width in pixels (computer tool). */ + displayWidthPx?: number | undefined; + /** The display height in pixels (computer tool). */ + displayHeightPx?: number | undefined; + /** Optional display number (computer tool). */ + displayNumber?: number | undefined; + /** The knowledge bases to query (query tool). */ + knowledgeBases?: Vapi.KnowledgeBase[] | undefined; + /** This is where the request will be sent (api-request tool). */ + url?: string | undefined; + /** This is the HTTP method for the request (api-request tool). */ + method?: Vapi.ToolDraftMethod | undefined; + /** These are the headers to send with the request (api-request / sip-request tool). */ + headers?: Vapi.JsonSchema | undefined; + /** + * This is the body of the request. Either a JSON schema (api-request) or a + * literal string / schema (sip-request). + */ + body?: Record | undefined; + /** This is the backoff plan if the request fails. */ + backoffPlan?: Vapi.BackoffPlan | undefined; + /** This is the timeout in seconds for the request. */ + timeoutSeconds?: number | undefined; + /** This is the description of the tool. This will be passed to the model. */ + description?: string | undefined; + /** This is the plan to extract variables from the tool's response. */ + variableExtractionPlan?: Vapi.VariableExtractionPlan | undefined; + /** This is the credential ID that will be used for authorization. */ + credentialId?: string | undefined; + extendedDelayWhenPrecededByTextEnabled?: boolean | undefined; + beepDetectionEnabled?: boolean | undefined; + /** This is the TypeScript code that will be executed when the tool is called (code tool). */ + code?: string | undefined; + /** These are the environment variables available in the code via the `env` object (code tool). */ + environmentVariables?: Vapi.CodeToolEnvironmentVariable[] | undefined; + /** These are the static parameters to merge into the tool's request body. */ + parameters?: Vapi.ToolParameter[] | undefined; + /** This is the paths to encrypt in the request body. */ + encryptedPaths?: string[] | undefined; + /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833. */ + sipInfoDtmfEnabled?: boolean | undefined; + /** This is the SIP method to send (sip-request tool). */ + verb?: Vapi.ToolDraftVerb | undefined; + /** This is the default local tool result message used when no runtime override is returned (handoff tool). */ + defaultResult?: string | undefined; + /** Per-tool message overrides for individual tools loaded from the MCP server (mcp tool). */ + toolMessages?: Vapi.McpToolMessages[] | undefined; +} diff --git a/src/api/types/ToolDraftConflictResponseDto.ts b/src/api/types/ToolDraftConflictResponseDto.ts new file mode 100644 index 00000000..ee2c09a9 --- /dev/null +++ b/src/api/types/ToolDraftConflictResponseDto.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface ToolDraftConflictResponseDto { + existingDraftId: string | null; + error: string; + message: string; +} diff --git a/src/api/types/ToolDraftMessagesItem.ts b/src/api/types/ToolDraftMessagesItem.ts new file mode 100644 index 00000000..fafebdd7 --- /dev/null +++ b/src/api/types/ToolDraftMessagesItem.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type ToolDraftMessagesItem = + | Vapi.ToolDraftMessagesItem.RequestStart + | Vapi.ToolDraftMessagesItem.RequestComplete + | Vapi.ToolDraftMessagesItem.RequestFailed + | Vapi.ToolDraftMessagesItem.RequestResponseDelayed; + +export namespace ToolDraftMessagesItem { + export interface RequestStart extends Vapi.ToolMessageStart { + type: "request-start"; + } + + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } + + export interface RequestResponseDelayed extends Vapi.ToolMessageDelayed { + type: "request-response-delayed"; + } +} diff --git a/src/api/types/ToolDraftMethod.ts b/src/api/types/ToolDraftMethod.ts new file mode 100644 index 00000000..d89335b0 --- /dev/null +++ b/src/api/types/ToolDraftMethod.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the HTTP method for the request (api-request tool). */ +export const ToolDraftMethod = { + Post: "POST", + Get: "GET", + Put: "PUT", + Patch: "PATCH", + Delete: "DELETE", +} as const; +export type ToolDraftMethod = (typeof ToolDraftMethod)[keyof typeof ToolDraftMethod]; diff --git a/src/api/types/ToolDraftPaginatedMetadata.ts b/src/api/types/ToolDraftPaginatedMetadata.ts new file mode 100644 index 00000000..2b0ce9bc --- /dev/null +++ b/src/api/types/ToolDraftPaginatedMetadata.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface ToolDraftPaginatedMetadata { + nextCursor: string | null; + hasNextPage: boolean; + limit: number; +} diff --git a/src/api/types/ToolDraftPaginatedResponse.ts b/src/api/types/ToolDraftPaginatedResponse.ts new file mode 100644 index 00000000..c8dea8a0 --- /dev/null +++ b/src/api/types/ToolDraftPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolDraftPaginatedResponse { + results: Vapi.ToolDraft[]; + metadata: Vapi.ToolDraftPaginatedMetadata; +} diff --git a/src/api/types/ToolDraftType.ts b/src/api/types/ToolDraftType.ts new file mode 100644 index 00000000..8795ad88 --- /dev/null +++ b/src/api/types/ToolDraftType.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the tool. */ +export const ToolDraftType = { + Dtmf: "dtmf", + EndCall: "endCall", + KnowledgeBase: "knowledgeBase", + TransferCall: "transferCall", + TransferCancel: "transferCancel", + TransferSuccessful: "transferSuccessful", + Handoff: "handoff", + Output: "output", + Voicemail: "voicemail", + Query: "query", + Sms: "sms", + SipRequest: "sipRequest", + Function: "function", + Mcp: "mcp", + ApiRequest: "apiRequest", + Code: "code", + Bash: "bash", + Computer: "computer", + TextEditor: "textEditor", + GoogleCalendarEventCreate: "google.calendar.event.create", + GoogleCalendarAvailabilityCheck: "google.calendar.availability.check", + GoogleSheetsRowAppend: "google.sheets.row.append", + SlackMessageSend: "slack.message.send", + GohighlevelCalendarEventCreate: "gohighlevel.calendar.event.create", + GohighlevelCalendarAvailabilityCheck: "gohighlevel.calendar.availability.check", + GohighlevelContactCreate: "gohighlevel.contact.create", + GohighlevelContactGet: "gohighlevel.contact.get", + Make: "make", + Ghl: "ghl", +} as const; +export type ToolDraftType = (typeof ToolDraftType)[keyof typeof ToolDraftType]; diff --git a/src/api/types/ToolDraftVerb.ts b/src/api/types/ToolDraftVerb.ts new file mode 100644 index 00000000..17d82fdf --- /dev/null +++ b/src/api/types/ToolDraftVerb.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the SIP method to send (sip-request tool). */ +export const ToolDraftVerb = { + Info: "INFO", + Message: "MESSAGE", + Notify: "NOTIFY", +} as const; +export type ToolDraftVerb = (typeof ToolDraftVerb)[keyof typeof ToolDraftVerb]; diff --git a/src/api/types/ToolMessage.ts b/src/api/types/ToolMessage.ts index 12a79dd9..fa7cff68 100644 --- a/src/api/types/ToolMessage.ts +++ b/src/api/types/ToolMessage.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A tool-result message associated with a specific tool call. + */ export interface ToolMessage { /** This is the role of the message author */ role: Vapi.ToolMessageRole; diff --git a/src/api/types/ToolMessageComplete.ts b/src/api/types/ToolMessageComplete.ts index b703487b..abfcee8f 100644 --- a/src/api/types/ToolMessageComplete.ts +++ b/src/api/types/ToolMessageComplete.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call completes, with optional language variants, argument conditions, role, and end-call behavior. + */ export interface ToolMessageComplete { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolMessageDelayed.ts b/src/api/types/ToolMessageDelayed.ts index fc133e4f..f05a108b 100644 --- a/src/api/types/ToolMessageDelayed.ts +++ b/src/api/types/ToolMessageDelayed.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument conditions. + */ export interface ToolMessageDelayed { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. @@ -13,7 +16,7 @@ export interface ToolMessageDelayed { * This will override the `content` property. */ contents?: Vapi.TextContent[] | undefined; - /** The number of milliseconds to wait for the server response before saying this message. */ + /** The number of milliseconds to wait for the server response before saying this delayed message. */ timingMilliseconds?: number | undefined; /** This is the content that the assistant says when this message is triggered. */ content?: string | undefined; diff --git a/src/api/types/ToolMessageFailed.ts b/src/api/types/ToolMessageFailed.ts index 40e696ec..436b3b6e 100644 --- a/src/api/types/ToolMessageFailed.ts +++ b/src/api/types/ToolMessageFailed.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call behavior. + */ export interface ToolMessageFailed { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. @@ -13,9 +16,27 @@ export interface ToolMessageFailed { * This will override the `content` property. */ contents?: Vapi.TextContent[] | undefined; + /** + * This is optional and defaults to "assistant". + * + * When role=assistant, `content` is said out loud when the tool call fails. + * + * When role=system, `content` is passed to the model as a system message + * along with the failure result, and the model's generated response is + * spoken. Example: + * assistant: tool called + * tool: error from your server + * <--- system prompt as hint + * ---> model generates response which is spoken + * This is useful when you want the model to generate an error-aware + * response instead of speaking a fixed failure message. + */ + role?: Vapi.ToolMessageFailedRole | undefined; /** * This is an optional boolean that if true, the call will end after the message is spoken. Default is false. * + * This is ignored if `role` is set to `system`. + * * @default false */ endCallAfterSpokenEnabled?: boolean | undefined; diff --git a/src/api/types/ToolMessageFailedRole.ts b/src/api/types/ToolMessageFailedRole.ts new file mode 100644 index 00000000..0b55ffff --- /dev/null +++ b/src/api/types/ToolMessageFailedRole.ts @@ -0,0 +1,22 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is optional and defaults to "assistant". + * + * When role=assistant, `content` is said out loud when the tool call fails. + * + * When role=system, `content` is passed to the model as a system message + * along with the failure result, and the model's generated response is + * spoken. Example: + * assistant: tool called + * tool: error from your server + * <--- system prompt as hint + * ---> model generates response which is spoken + * This is useful when you want the model to generate an error-aware + * response instead of speaking a fixed failure message. + */ +export const ToolMessageFailedRole = { + Assistant: "assistant", + System: "system", +} as const; +export type ToolMessageFailedRole = (typeof ToolMessageFailedRole)[keyof typeof ToolMessageFailedRole]; diff --git a/src/api/types/ToolMessageStart.ts b/src/api/types/ToolMessageStart.ts index e00978c7..9693dd5a 100644 --- a/src/api/types/ToolMessageStart.ts +++ b/src/api/types/ToolMessageStart.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking behavior. + */ export interface ToolMessageStart { /** * This is an alternative to the `content` property. It allows to specify variants of the same content, one per language. diff --git a/src/api/types/ToolNode.ts b/src/api/types/ToolNode.ts index 8c474c5d..cab7be24 100644 --- a/src/api/types/ToolNode.ts +++ b/src/api/types/ToolNode.ts @@ -2,11 +2,15 @@ import type * as Vapi from "../index.js"; +/** + * A workflow node that invokes an inline tool or an existing saved tool. + */ export interface ToolNode { /** This is the tool to call. To use an existing tool, send `toolId` instead. */ tool?: Vapi.ToolNodeTool | undefined; /** This is the tool to call. To use a transient tool, send `tool` instead. */ toolId?: string | undefined; + /** Unique name used to identify this workflow node. */ name: string; /** This is whether or not the node is the start of the workflow. */ isStart?: boolean | undefined; diff --git a/src/api/types/ToolNodeTool.ts b/src/api/types/ToolNodeTool.ts index acebc057..67f6abe4 100644 --- a/src/api/types/ToolNodeTool.ts +++ b/src/api/types/ToolNodeTool.ts @@ -122,4 +122,32 @@ export namespace ToolNodeTool { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + /** + * This is the tool to call. To use an existing tool, send `toolId` instead. + */ + export type Response = + | Vapi.ToolNodeTool.ApiRequest + | Vapi.ToolNodeTool.Bash + | Vapi.ToolNodeTool.Code + | Vapi.ToolNodeTool.Computer + | Vapi.ToolNodeTool.Dtmf + | Vapi.ToolNodeTool.EndCall + | Vapi.ToolNodeTool.Function + | Vapi.ToolNodeTool.GohighlevelCalendarAvailabilityCheck + | Vapi.ToolNodeTool.GohighlevelCalendarEventCreate + | Vapi.ToolNodeTool.GohighlevelContactCreate + | Vapi.ToolNodeTool.GohighlevelContactGet + | Vapi.ToolNodeTool.GoogleCalendarAvailabilityCheck + | Vapi.ToolNodeTool.GoogleCalendarEventCreate + | Vapi.ToolNodeTool.GoogleSheetsRowAppend + | Vapi.ToolNodeTool.Handoff + | Vapi.ToolNodeTool.Mcp + | Vapi.ToolNodeTool.Query + | Vapi.ToolNodeTool.SlackMessageSend + | Vapi.ToolNodeTool.Sms + | Vapi.ToolNodeTool.TextEditor + | Vapi.ToolNodeTool.TransferCall + | Vapi.ToolNodeTool.SipRequest + | Vapi.ToolNodeTool.Voicemail; } diff --git a/src/api/types/ToolParameter.ts b/src/api/types/ToolParameter.ts index e0fa717f..059172b3 100644 --- a/src/api/types/ToolParameter.ts +++ b/src/api/types/ToolParameter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Static key-value parameter added to a tool request, with Liquid template support for string values. + */ export interface ToolParameter { /** This is the key of the parameter. */ key: string; diff --git a/src/api/types/ToolPinnedConflictResponseDto.ts b/src/api/types/ToolPinnedConflictResponseDto.ts new file mode 100644 index 00000000..03018545 --- /dev/null +++ b/src/api/types/ToolPinnedConflictResponseDto.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolPinnedConflictResponseDto { + error: Vapi.ToolPinnedConflictResponseDtoError; + /** Human-readable reason the parent-tool delete was rejected. */ + message: string; +} diff --git a/src/api/types/ToolPinnedConflictResponseDtoError.ts b/src/api/types/ToolPinnedConflictResponseDtoError.ts new file mode 100644 index 00000000..bc8430f9 --- /dev/null +++ b/src/api/types/ToolPinnedConflictResponseDtoError.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const ToolPinnedConflictResponseDtoError = { + ToolPinned: "tool_pinned", +} as const; +export type ToolPinnedConflictResponseDtoError = + (typeof ToolPinnedConflictResponseDtoError)[keyof typeof ToolPinnedConflictResponseDtoError]; diff --git a/src/api/types/ToolRef.ts b/src/api/types/ToolRef.ts new file mode 100644 index 00000000..02bf303d --- /dev/null +++ b/src/api/types/ToolRef.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface ToolRef { + /** This is the unique identifier of the tool whose version is being pinned. */ + toolId: string; + /** Public version label of the tool, e.g. "v3" */ + version: string; +} diff --git a/src/api/types/ToolRejectionPlan.ts b/src/api/types/ToolRejectionPlan.ts index 6be37e56..8017d132 100644 --- a/src/api/types/ToolRejectionPlan.ts +++ b/src/api/types/ToolRejectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Conditions evaluated to determine whether a requested tool call should be rejected. + */ export interface ToolRejectionPlan { /** * This is the list of conditions that must be evaluated. diff --git a/src/api/types/ToolVersion.ts b/src/api/types/ToolVersion.ts new file mode 100644 index 00000000..93714e78 --- /dev/null +++ b/src/api/types/ToolVersion.ts @@ -0,0 +1,65 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolVersion { + /** Optional human-readable label for this version. Pass `null` to clear. */ + versionName?: (string | null) | undefined; + /** Optional description for this version. Pass `null` to clear. */ + versionDescription?: (string | null) | undefined; + type?: Record | undefined; + function?: (Record | null) | undefined; + messages?: (Record[] | null) | undefined; + metadata?: (Record | null) | undefined; + templateId?: (string | null) | undefined; + server?: (Vapi.Server | null) | undefined; + async?: (boolean | null) | undefined; + destinations?: (Record[] | null) | undefined; + name?: (string | null) | undefined; + subType?: (string | null) | undefined; + displayWidthPx?: (number | null) | undefined; + displayHeightPx?: (number | null) | undefined; + displayNumber?: (number | null) | undefined; + knowledgeBases?: (Record[] | null) | undefined; + url?: (string | null) | undefined; + method?: (string | null) | undefined; + headers?: (Record | null) | undefined; + body?: Record | undefined; + backoffPlan?: (Record | null) | undefined; + timeoutSeconds?: (number | null) | undefined; + description?: (string | null) | undefined; + variableExtractionPlan?: (Record | null) | undefined; + rejectionPlan?: (Record | null) | undefined; + credentialId?: (string | null) | undefined; + extendedDelayWhenPrecededByTextEnabled?: (boolean | null) | undefined; + beepDetectionEnabled?: (boolean | null) | undefined; + code?: (string | null) | undefined; + environmentVariables?: (Record[] | null) | undefined; + parameters?: (Record[] | null) | undefined; + encryptedPaths?: (string[] | null) | undefined; + sipInfoDtmfEnabled?: (boolean | null) | undefined; + verb?: (string | null) | undefined; + defaultResult?: (string | null) | undefined; + toolMessages?: (Record[] | null) | undefined; + /** This is the unique identifier for the version row. */ + id: string; + /** This is the unique identifier for the org that owns this version. */ + orgId: string; + /** This is the unique identifier for the tool this version was snapshotted from. */ + toolId: string; + /** + * This is the public monotonic version label, e.g. "v1". + * System-owned and incremented per tool; never user-supplied. + */ + version: string; + /** This is the SHA-256 hex of the snapshotted content used for no-op detection. */ + configHash: string; + /** This is the prior version label (vN-1). Null on v1 or for branch roots. */ + parentVersion?: (string | null) | undefined; + /** This is the actor that wrote this version. Email when created via JWT, null when created via API. */ + createdBy?: (string | null) | undefined; + /** This is the soft-delete timestamp. Null when active. */ + deletedAt?: (string | null) | undefined; + /** This is the ISO 8601 date-time string of when the version was created. */ + createdAt: string; +} diff --git a/src/api/types/ToolVersionPaginatedMetadata.ts b/src/api/types/ToolVersionPaginatedMetadata.ts new file mode 100644 index 00000000..f4a42432 --- /dev/null +++ b/src/api/types/ToolVersionPaginatedMetadata.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface ToolVersionPaginatedMetadata { + nextCursor?: (string | null) | undefined; + hasNextPage: boolean; + limit: number; +} diff --git a/src/api/types/ToolVersionPaginatedResponse.ts b/src/api/types/ToolVersionPaginatedResponse.ts new file mode 100644 index 00000000..f85f7a2d --- /dev/null +++ b/src/api/types/ToolVersionPaginatedResponse.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface ToolVersionPaginatedResponse { + results: Vapi.ToolVersion[]; + metadata: Vapi.ToolVersionPaginatedMetadata; +} diff --git a/src/api/types/TranscriberCost.ts b/src/api/types/TranscriberCost.ts index fcaef650..8d07548d 100644 --- a/src/api/types/TranscriberCost.ts +++ b/src/api/types/TranscriberCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Speech-to-text cost for a call, including transcriber, billable minutes, and amount. + */ export interface TranscriberCost { /** * This is the transcriber that was used during the call. diff --git a/src/api/types/TranscriptPlan.ts b/src/api/types/TranscriptPlan.ts index fe931527..f3a9c190 100644 --- a/src/api/types/TranscriptPlan.ts +++ b/src/api/types/TranscriptPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls whether the call transcript is stored and the speaker names used in the transcript. + */ export interface TranscriptPlan { /** * This determines whether the transcript is stored in `call.artifact.transcript`. Defaults to true. diff --git a/src/api/types/TranscriptionEndpointingPlan.ts b/src/api/types/TranscriptionEndpointingPlan.ts index 3f781af1..e0ec03c5 100644 --- a/src/api/types/TranscriptionEndpointingPlan.ts +++ b/src/api/types/TranscriptionEndpointingPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a number. + */ export interface TranscriptionEndpointingPlan { /** * The minimum number of seconds to wait after transcription ending with punctuation before sending a request to the model. Defaults to 0.1. diff --git a/src/api/types/TransferArtifact.ts b/src/api/types/TransferArtifact.ts new file mode 100644 index 00000000..a2919713 --- /dev/null +++ b/src/api/types/TransferArtifact.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface TransferArtifact { + /** The transfer destination (phone number or SIP URI). */ + destination: Vapi.TransferArtifactDestination; + /** The transfer mode (e.g. warm-transfer-experimental, blind-transfer). */ + mode?: Vapi.TransferArtifactMode | undefined; + /** Flat-text transcript / announcement preview of the transfer. */ + transcript?: string | undefined; + /** The terminal status of the transfer, rendered as the status line. */ + status?: Vapi.TransferArtifactStatus | undefined; + /** + * The agent↔operator conversation captured during a + * warm-transfer-experimental, rendered as bubbles. + */ + messages?: Vapi.TransferArtifactMessagesItem[] | undefined; +} diff --git a/src/api/types/TransferArtifactDestination.ts b/src/api/types/TransferArtifactDestination.ts new file mode 100644 index 00000000..590e38ee --- /dev/null +++ b/src/api/types/TransferArtifactDestination.ts @@ -0,0 +1,20 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * The transfer destination (phone number or SIP URI). + */ +export type TransferArtifactDestination = + | Vapi.TransferArtifactDestination.Number + | Vapi.TransferArtifactDestination.Sip; + +export namespace TransferArtifactDestination { + export interface Number extends Vapi.TransferDestinationNumber { + type: "number"; + } + + export interface Sip extends Vapi.TransferDestinationSip { + type: "sip"; + } +} diff --git a/src/api/types/TransferArtifactMessagesItem.ts b/src/api/types/TransferArtifactMessagesItem.ts new file mode 100644 index 00000000..8cf2e6c1 --- /dev/null +++ b/src/api/types/TransferArtifactMessagesItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type TransferArtifactMessagesItem = + | Vapi.UserMessage + | Vapi.SystemMessage + | Vapi.BotMessage + | Vapi.ToolCallMessage + | Vapi.ToolCallResultMessage; diff --git a/src/api/types/TransferArtifactMode.ts b/src/api/types/TransferArtifactMode.ts new file mode 100644 index 00000000..ae377124 --- /dev/null +++ b/src/api/types/TransferArtifactMode.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The transfer mode (e.g. warm-transfer-experimental, blind-transfer). */ +export const TransferArtifactMode = { + BlindTransfer: "blind-transfer", + BlindTransferAddSummaryToSipHeader: "blind-transfer-add-summary-to-sip-header", + WarmTransferSayMessage: "warm-transfer-say-message", + WarmTransferSaySummary: "warm-transfer-say-summary", + WarmTransferTwiml: "warm-transfer-twiml", + WarmTransferWaitForOperatorToSpeakFirstAndThenSayMessage: + "warm-transfer-wait-for-operator-to-speak-first-and-then-say-message", + WarmTransferWaitForOperatorToSpeakFirstAndThenSaySummary: + "warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary", + WarmTransferExperimental: "warm-transfer-experimental", +} as const; +export type TransferArtifactMode = (typeof TransferArtifactMode)[keyof typeof TransferArtifactMode]; diff --git a/src/api/types/TransferArtifactStatus.ts b/src/api/types/TransferArtifactStatus.ts new file mode 100644 index 00000000..c361d7ad --- /dev/null +++ b/src/api/types/TransferArtifactStatus.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The terminal status of the transfer, rendered as the status line. */ +export const TransferArtifactStatus = { + Connected: "connected", + NoAnswer: "no-answer", + Busy: "busy", + Voicemail: "voicemail", + Failed: "failed", + Completed: "completed", + Cancelled: "cancelled", +} as const; +export type TransferArtifactStatus = (typeof TransferArtifactStatus)[keyof typeof TransferArtifactStatus]; diff --git a/src/api/types/TransferAssistantTranscriber.ts b/src/api/types/TransferAssistantTranscriber.ts index bb051e7f..f120358c 100644 --- a/src/api/types/TransferAssistantTranscriber.ts +++ b/src/api/types/TransferAssistantTranscriber.ts @@ -17,7 +17,9 @@ export type TransferAssistantTranscriber = | Vapi.TransferAssistantTranscriber.Talkscriber | Vapi.TransferAssistantTranscriber.Openai | Vapi.TransferAssistantTranscriber.Cartesia - | Vapi.TransferAssistantTranscriber.Soniox; + | Vapi.TransferAssistantTranscriber.Soniox + | Vapi.TransferAssistantTranscriber.Xai + | Vapi.TransferAssistantTranscriber.Vapi; export namespace TransferAssistantTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -67,4 +69,12 @@ export namespace TransferAssistantTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/TransferAssistantVoice.ts b/src/api/types/TransferAssistantVoice.ts index 5910de64..3dfc1e0a 100644 --- a/src/api/types/TransferAssistantVoice.ts +++ b/src/api/types/TransferAssistantVoice.ts @@ -23,7 +23,9 @@ export type TransferAssistantVoice = | Vapi.TransferAssistantVoice.Vapi | Vapi.TransferAssistantVoice.Sesame | Vapi.TransferAssistantVoice.Inworld - | Vapi.TransferAssistantVoice.Minimax; + | Vapi.TransferAssistantVoice.Minimax + | Vapi.TransferAssistantVoice.Xai + | Vapi.TransferAssistantVoice.Microsoft; export namespace TransferAssistantVoice { export interface Azure extends Vapi.AzureVoice { @@ -97,4 +99,12 @@ export namespace TransferAssistantVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/TransferCallTool.ts b/src/api/types/TransferCallTool.ts index bac596b6..dc9a99da 100644 --- a/src/api/types/TransferCallTool.ts +++ b/src/api/types/TransferCallTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable tool that transfers the active call to one of its configured destinations. + */ export interface TransferCallTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.TransferCallToolMessagesItem[] | undefined; /** 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. */ destinations?: Vapi.TransferCallToolDestinationsItem[] | undefined; diff --git a/src/api/types/TransferCancelToolUserEditable.ts b/src/api/types/TransferCancelToolUserEditable.ts index ba086537..576c8e1c 100644 --- a/src/api/types/TransferCancelToolUserEditable.ts +++ b/src/api/types/TransferCancelToolUserEditable.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface TransferCancelToolUserEditable { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.TransferCancelToolUserEditableMessagesItem[] | undefined; /** The type of tool. "transferCancel" for Transfer Cancel tool. This tool can only be used during warm-transfer-experimental by the transfer assistant to cancel an ongoing transfer and return the call back to the original assistant when the transfer cannot be completed. */ type: Vapi.TransferCancelToolUserEditableType; diff --git a/src/api/types/TransferDestinationAssistant.ts b/src/api/types/TransferDestinationAssistant.ts index 15c2c333..b4fce0c8 100644 --- a/src/api/types/TransferDestinationAssistant.ts +++ b/src/api/types/TransferDestinationAssistant.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to another assistant by name, with an optional message and assistant-transfer mode. + */ export interface TransferDestinationAssistant { /** * This is spoken to the customer before connecting them to the destination. @@ -13,6 +16,7 @@ export interface TransferDestinationAssistant { * This accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field. */ message?: Vapi.TransferDestinationAssistantMessage | undefined; + /** Selects another assistant as the transfer destination. */ type: Vapi.TransferDestinationAssistantType; /** * This is the mode to use for the transfer. Defaults to `rolling-history`. diff --git a/src/api/types/TransferDestinationAssistantType.ts b/src/api/types/TransferDestinationAssistantType.ts index cb7910c1..72f003a7 100644 --- a/src/api/types/TransferDestinationAssistantType.ts +++ b/src/api/types/TransferDestinationAssistantType.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects another assistant as the transfer destination. */ export const TransferDestinationAssistantType = { Assistant: "assistant", } as const; diff --git a/src/api/types/TransferDestinationNumber.ts b/src/api/types/TransferDestinationNumber.ts index 1f941e7e..a911b243 100644 --- a/src/api/types/TransferDestinationNumber.ts +++ b/src/api/types/TransferDestinationNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number validation. + */ export interface TransferDestinationNumber { /** * This is spoken to the customer before connecting them to the destination. diff --git a/src/api/types/TransferDestinationSip.ts b/src/api/types/TransferDestinationSip.ts index 852512b9..ce00508e 100644 --- a/src/api/types/TransferDestinationSip.ts +++ b/src/api/types/TransferDestinationSip.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan. + */ export interface TransferDestinationSip { /** * This is spoken to the customer before connecting them to the destination. diff --git a/src/api/types/TransferFallbackPlan.ts b/src/api/types/TransferFallbackPlan.ts index 46be634b..d4f59759 100644 --- a/src/api/types/TransferFallbackPlan.ts +++ b/src/api/types/TransferFallbackPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls the message and end-call behavior used when a call transfer fails. + */ export interface TransferFallbackPlan { /** This is the message the assistant will deliver to the customer if the transfer fails. */ message: Vapi.TransferFallbackPlanMessage; diff --git a/src/api/types/TransferPhoneNumberHookAction.ts b/src/api/types/TransferPhoneNumberHookAction.ts index 5cb3e0c6..91f7c23e 100644 --- a/src/api/types/TransferPhoneNumberHookAction.ts +++ b/src/api/types/TransferPhoneNumberHookAction.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A phone-number hook action that transfers the call to a phone number or SIP destination. + */ export interface TransferPhoneNumberHookAction { /** This is the destination details for the transfer - can be a phone number or SIP URI */ destination?: Vapi.TransferPhoneNumberHookActionDestination | undefined; diff --git a/src/api/types/TransferPlan.ts b/src/api/types/TransferPlan.ts index dde3a1f5..ba26899f 100644 --- a/src/api/types/TransferPlan.ts +++ b/src/api/types/TransferPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Controls how a call transfer is executed, including blind and warm transfer modes, dialing and SIP behavior, hold audio, context, summary, and failure handling. + */ export interface TransferPlan { /** * This configures how transfer is executed and the experience of the destination party receiving the call. @@ -113,8 +116,10 @@ export interface TransferPlan { * This configures the fallback plan when the transfer fails (destination unreachable, busy, or not human). * * Usage: - * - Used only when `mode` is `warm-transfer-experimental`. - * - If not provided when using `warm-transfer-experimental`, a default message will be used. + * - Used when `mode` is `warm-transfer-experimental`. If not provided, a default message will be used. + * - Used for SIP cold transfers (`blind-transfer` modes) when transfer outcome detection and fallback + * are enabled for the organization: on a failed transfer, the assistant speaks `message`, then ends + * the call or continues with the customer per `endCallEnabled`. */ fallbackPlan?: Vapi.TransferFallbackPlan | undefined; } diff --git a/src/api/types/TransferSuccessfulToolUserEditable.ts b/src/api/types/TransferSuccessfulToolUserEditable.ts index f5653e3f..2ddd06af 100644 --- a/src/api/types/TransferSuccessfulToolUserEditable.ts +++ b/src/api/types/TransferSuccessfulToolUserEditable.ts @@ -3,11 +3,7 @@ import type * as Vapi from "../index.js"; export interface TransferSuccessfulToolUserEditable { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.TransferSuccessfulToolUserEditableMessagesItem[] | undefined; /** The type of tool. "transferSuccessful" for Transfer Successful tool. This tool can only be used during warm-transfer-experimental by the transfer assistant to confirm that the transfer should proceed and finalize the handoff to the destination. */ type: Vapi.TransferSuccessfulToolUserEditableType; diff --git a/src/api/types/TransportConfigurationTwilio.ts b/src/api/types/TransportConfigurationTwilio.ts index a97bc4c3..6b57b8e2 100644 --- a/src/api/types/TransportConfigurationTwilio.ts +++ b/src/api/types/TransportConfigurationTwilio.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior. + */ export interface TransportConfigurationTwilio { + /** Selects Twilio as the call transport provider. */ provider: Vapi.TransportConfigurationTwilioProvider; /** * The integer number of seconds that we should allow the phone to ring before assuming there is no answer. diff --git a/src/api/types/TransportConfigurationTwilioProvider.ts b/src/api/types/TransportConfigurationTwilioProvider.ts index f5cdd277..f7ca50cc 100644 --- a/src/api/types/TransportConfigurationTwilioProvider.ts +++ b/src/api/types/TransportConfigurationTwilioProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Selects Twilio as the call transport provider. */ export const TransportConfigurationTwilioProvider = { Twilio: "twilio", } as const; diff --git a/src/api/types/TransportCost.ts b/src/api/types/TransportCost.ts index e40bed6b..bf840299 100644 --- a/src/api/types/TransportCost.ts +++ b/src/api/types/TransportCost.ts @@ -2,7 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Telephony transport cost for a call, including provider, billable minutes, and amount. + */ export interface TransportCost { + /** Telephony or transport provider that generated the cost. */ provider?: Vapi.TransportCostProvider | undefined; /** This is the minutes of `transport` usage. This should match `call.endedAt` - `call.startedAt`. */ minutes: number; diff --git a/src/api/types/TransportCostProvider.ts b/src/api/types/TransportCostProvider.ts index 8295a535..8d0c28c7 100644 --- a/src/api/types/TransportCostProvider.ts +++ b/src/api/types/TransportCostProvider.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** Telephony or transport provider that generated the cost. */ export const TransportCostProvider = { Daily: "daily", VapiWebsocket: "vapi.websocket", diff --git a/src/api/types/TrieveCredentialProvider.ts b/src/api/types/TrieveCredentialProvider.ts deleted file mode 100644 index 3b6e9457..00000000 --- a/src/api/types/TrieveCredentialProvider.ts +++ /dev/null @@ -1,6 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export const TrieveCredentialProvider = { - Trieve: "trieve", -} as const; -export type TrieveCredentialProvider = (typeof TrieveCredentialProvider)[keyof typeof TrieveCredentialProvider]; diff --git a/src/api/types/TrieveKnowledgeBase.ts b/src/api/types/TrieveKnowledgeBase.ts index 9a9fd69c..93a41d3b 100644 --- a/src/api/types/TrieveKnowledgeBase.ts +++ b/src/api/types/TrieveKnowledgeBase.ts @@ -1,28 +1,3 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; - -export interface TrieveKnowledgeBase { - /** - * This knowledge base is provided by Trieve. - * - * To learn more about Trieve, visit https://trieve.ai. - */ - provider: Vapi.TrieveKnowledgeBaseProvider; - /** This is the name of the knowledge base. */ - name?: string | undefined; - /** - * This is the searching plan used when searching for relevant chunks from the vector store. - * - * You should configure this if you're running into these issues: - * - Too much unnecessary context is being fed as knowledge base context. - * - Not enough relevant context is being fed as knowledge base context. - */ - searchPlan?: Vapi.TrieveKnowledgeBaseSearchPlan | undefined; - /** This is the plan if you want us to create/import a new vector store using Trieve. */ - createPlan?: Vapi.TrieveKnowledgeBaseImport | undefined; - /** This is the id of the knowledge base. */ - id: string; - /** This is the org id of the knowledge base. */ - orgId: string; -} +export type TrieveKnowledgeBase = unknown; diff --git a/src/api/types/TrieveKnowledgeBaseChunkPlan.ts b/src/api/types/TrieveKnowledgeBaseChunkPlan.ts deleted file mode 100644 index 70575f92..00000000 --- a/src/api/types/TrieveKnowledgeBaseChunkPlan.ts +++ /dev/null @@ -1,14 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export interface TrieveKnowledgeBaseChunkPlan { - /** These are the file ids that will be used to create the vector store. To upload files, use the `POST /files` endpoint. */ - fileIds?: string[] | undefined; - /** These are the websites that will be used to create the vector store. */ - websites?: string[] | undefined; - /** This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number. */ - targetSplitsPerChunk?: number | undefined; - /** This is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\n] are used to split into sentences. However, you may want to use spaces or other delimiters. */ - splitDelimiters?: string[] | undefined; - /** This is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks with 22 splits each. */ - rebalanceChunks?: boolean | undefined; -} diff --git a/src/api/types/TrieveKnowledgeBaseCreate.ts b/src/api/types/TrieveKnowledgeBaseCreate.ts deleted file mode 100644 index bc018b85..00000000 --- a/src/api/types/TrieveKnowledgeBaseCreate.ts +++ /dev/null @@ -1,10 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -import type * as Vapi from "../index.js"; - -export interface TrieveKnowledgeBaseCreate { - /** This is to create a new dataset on Trieve. */ - type: Vapi.TrieveKnowledgeBaseCreateType; - /** These are the chunk plans used to create the dataset. */ - chunkPlans: Vapi.TrieveKnowledgeBaseChunkPlan[]; -} diff --git a/src/api/types/TrieveKnowledgeBaseCreateType.ts b/src/api/types/TrieveKnowledgeBaseCreateType.ts deleted file mode 100644 index 1800167a..00000000 --- a/src/api/types/TrieveKnowledgeBaseCreateType.ts +++ /dev/null @@ -1,8 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** This is to create a new dataset on Trieve. */ -export const TrieveKnowledgeBaseCreateType = { - Create: "create", -} as const; -export type TrieveKnowledgeBaseCreateType = - (typeof TrieveKnowledgeBaseCreateType)[keyof typeof TrieveKnowledgeBaseCreateType]; diff --git a/src/api/types/TrieveKnowledgeBaseImport.ts b/src/api/types/TrieveKnowledgeBaseImport.ts index 9535b2c0..e03a8104 100644 --- a/src/api/types/TrieveKnowledgeBaseImport.ts +++ b/src/api/types/TrieveKnowledgeBaseImport.ts @@ -1,10 +1,3 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; - -export interface TrieveKnowledgeBaseImport { - /** This is to import an existing dataset from Trieve. */ - type: Vapi.TrieveKnowledgeBaseImportType; - /** This is the `datasetId` of the dataset on your Trieve account. */ - providerId: string; -} +export type TrieveKnowledgeBaseImport = unknown; diff --git a/src/api/types/TrieveKnowledgeBaseImportType.ts b/src/api/types/TrieveKnowledgeBaseImportType.ts deleted file mode 100644 index 5ae4b9a1..00000000 --- a/src/api/types/TrieveKnowledgeBaseImportType.ts +++ /dev/null @@ -1,8 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** This is to import an existing dataset from Trieve. */ -export const TrieveKnowledgeBaseImportType = { - Import: "import", -} as const; -export type TrieveKnowledgeBaseImportType = - (typeof TrieveKnowledgeBaseImportType)[keyof typeof TrieveKnowledgeBaseImportType]; diff --git a/src/api/types/TrieveKnowledgeBaseProvider.ts b/src/api/types/TrieveKnowledgeBaseProvider.ts deleted file mode 100644 index 008a9f36..00000000 --- a/src/api/types/TrieveKnowledgeBaseProvider.ts +++ /dev/null @@ -1,12 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** - * This knowledge base is provided by Trieve. - * - * To learn more about Trieve, visit https://trieve.ai. - */ -export const TrieveKnowledgeBaseProvider = { - Trieve: "trieve", -} as const; -export type TrieveKnowledgeBaseProvider = - (typeof TrieveKnowledgeBaseProvider)[keyof typeof TrieveKnowledgeBaseProvider]; diff --git a/src/api/types/TrieveKnowledgeBaseSearchPlan.ts b/src/api/types/TrieveKnowledgeBaseSearchPlan.ts deleted file mode 100644 index cb609945..00000000 --- a/src/api/types/TrieveKnowledgeBaseSearchPlan.ts +++ /dev/null @@ -1,14 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -import type * as Vapi from "../index.js"; - -export interface TrieveKnowledgeBaseSearchPlan { - /** Specifies the number of top chunks to return. This corresponds to the `page_size` parameter in Trieve. */ - topK?: number | undefined; - /** If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. This will preserve queries that are entirely stop words. */ - removeStopWords?: boolean | undefined; - /** This is the score threshold to filter out chunks with a score below the threshold for cosine distance metric. For Manhattan Distance, Euclidean Distance, and Dot Product, it will filter out scores above the threshold distance. This threshold applies before weight and bias modifications. If not specified, this defaults to no threshold. A threshold of 0 will default to no threshold. */ - scoreThreshold?: number | undefined; - /** This is the search method used when searching for relevant chunks from the vector store. */ - searchType: Vapi.TrieveKnowledgeBaseSearchPlanSearchType; -} diff --git a/src/api/types/TrieveKnowledgeBaseSearchPlanSearchType.ts b/src/api/types/TrieveKnowledgeBaseSearchPlanSearchType.ts deleted file mode 100644 index 76a9fa14..00000000 --- a/src/api/types/TrieveKnowledgeBaseSearchPlanSearchType.ts +++ /dev/null @@ -1,11 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** This is the search method used when searching for relevant chunks from the vector store. */ -export const TrieveKnowledgeBaseSearchPlanSearchType = { - Fulltext: "fulltext", - Semantic: "semantic", - Hybrid: "hybrid", - Bm25: "bm25", -} as const; -export type TrieveKnowledgeBaseSearchPlanSearchType = - (typeof TrieveKnowledgeBaseSearchPlanSearchType)[keyof typeof TrieveKnowledgeBaseSearchPlanSearchType]; diff --git a/src/api/types/TurnLatency.ts b/src/api/types/TurnLatency.ts index b87e65a4..05299d3a 100644 --- a/src/api/types/TurnLatency.ts +++ b/src/api/types/TurnLatency.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Model, voice, transcription, endpointing, and total latency measurements for a conversation turn. + */ export interface TurnLatency { /** This is the model latency for the first token. */ modelLatency?: number | undefined; diff --git a/src/api/types/TwilioPhoneNumber.ts b/src/api/types/TwilioPhoneNumber.ts index d37b1c1d..8bb6343f 100644 --- a/src/api/types/TwilioPhoneNumber.ts +++ b/src/api/types/TwilioPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata. + */ export interface TwilioPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/TwilioTransport.ts b/src/api/types/TwilioTransport.ts new file mode 100644 index 00000000..ac3b0cf3 --- /dev/null +++ b/src/api/types/TwilioTransport.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface TwilioTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.TwilioTransportConversationType | undefined; + /** This is the account SID of the Twilio account. */ + accountSid?: string | undefined; + /** This is the call SID of the Twilio call. */ + callSid?: string | undefined; + /** This is the call token of the Twilio call. */ + callToken?: string | undefined; + /** + * This is the phone number from which the call was forwarded. + * Undefined if the call was not forwarded. + */ + forwardedFrom?: string | undefined; +} diff --git a/src/api/types/TwilioTransportConversationType.ts b/src/api/types/TwilioTransportConversationType.ts new file mode 100644 index 00000000..e3e33299 --- /dev/null +++ b/src/api/types/TwilioTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const TwilioTransportConversationType = { + Voice: "voice", +} as const; +export type TwilioTransportConversationType = + (typeof TwilioTransportConversationType)[keyof typeof TwilioTransportConversationType]; diff --git a/src/api/types/TwilioVoicemailDetectionPlan.ts b/src/api/types/TwilioVoicemailDetectionPlan.ts index b0cdbf89..24717207 100644 --- a/src/api/types/TwilioVoicemailDetectionPlan.ts +++ b/src/api/types/TwilioVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech thresholds, and silence timeout. + */ export interface TwilioVoicemailDetectionPlan { /** This is the provider to use for voicemail detection. */ provider: Vapi.TwilioVoicemailDetectionPlanProvider; diff --git a/src/api/types/UpdateAnthropicBedrockCredentialDto.ts b/src/api/types/UpdateAnthropicBedrockCredentialDto.ts index a5778caf..fa754c44 100644 --- a/src/api/types/UpdateAnthropicBedrockCredentialDto.ts +++ b/src/api/types/UpdateAnthropicBedrockCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateAnthropicBedrockCredentialDto { + provider?: Vapi.UpdateAnthropicBedrockCredentialDtoProvider | undefined; /** AWS region where Bedrock is configured. */ region?: Vapi.UpdateAnthropicBedrockCredentialDtoRegion | undefined; /** Authentication method - either direct IAM credentials or cross-account role assumption. */ diff --git a/src/api/types/UpdateAnthropicBedrockCredentialDtoProvider.ts b/src/api/types/UpdateAnthropicBedrockCredentialDtoProvider.ts new file mode 100644 index 00000000..24f7f50a --- /dev/null +++ b/src/api/types/UpdateAnthropicBedrockCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAnthropicBedrockCredentialDtoProvider = { + AnthropicBedrock: "anthropic-bedrock", +} as const; +export type UpdateAnthropicBedrockCredentialDtoProvider = + (typeof UpdateAnthropicBedrockCredentialDtoProvider)[keyof typeof UpdateAnthropicBedrockCredentialDtoProvider]; diff --git a/src/api/types/UpdateAnthropicBedrockCredentialDtoRegion.ts b/src/api/types/UpdateAnthropicBedrockCredentialDtoRegion.ts index 49ff3a8e..696ebfe6 100644 --- a/src/api/types/UpdateAnthropicBedrockCredentialDtoRegion.ts +++ b/src/api/types/UpdateAnthropicBedrockCredentialDtoRegion.ts @@ -4,6 +4,7 @@ export const UpdateAnthropicBedrockCredentialDtoRegion = { UsEast1: "us-east-1", UsWest2: "us-west-2", + EuCentral1: "eu-central-1", EuWest1: "eu-west-1", EuWest3: "eu-west-3", ApNortheast1: "ap-northeast-1", diff --git a/src/api/types/UpdateAnthropicCredentialDto.ts b/src/api/types/UpdateAnthropicCredentialDto.ts index 3ece47cf..ee854cf5 100644 --- a/src/api/types/UpdateAnthropicCredentialDto.ts +++ b/src/api/types/UpdateAnthropicCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateAnthropicCredentialDto { + provider?: Vapi.UpdateAnthropicCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateAnthropicCredentialDtoProvider.ts b/src/api/types/UpdateAnthropicCredentialDtoProvider.ts new file mode 100644 index 00000000..952970b0 --- /dev/null +++ b/src/api/types/UpdateAnthropicCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAnthropicCredentialDtoProvider = { + Anthropic: "anthropic", +} as const; +export type UpdateAnthropicCredentialDtoProvider = + (typeof UpdateAnthropicCredentialDtoProvider)[keyof typeof UpdateAnthropicCredentialDtoProvider]; diff --git a/src/api/types/UpdateAnyscaleCredentialDto.ts b/src/api/types/UpdateAnyscaleCredentialDto.ts index 79972879..cd93b488 100644 --- a/src/api/types/UpdateAnyscaleCredentialDto.ts +++ b/src/api/types/UpdateAnyscaleCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateAnyscaleCredentialDto { + provider?: Vapi.UpdateAnyscaleCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateAnyscaleCredentialDtoProvider.ts b/src/api/types/UpdateAnyscaleCredentialDtoProvider.ts new file mode 100644 index 00000000..e3fb49e8 --- /dev/null +++ b/src/api/types/UpdateAnyscaleCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAnyscaleCredentialDtoProvider = { + Anyscale: "anyscale", +} as const; +export type UpdateAnyscaleCredentialDtoProvider = + (typeof UpdateAnyscaleCredentialDtoProvider)[keyof typeof UpdateAnyscaleCredentialDtoProvider]; diff --git a/src/api/types/UpdateApiRequestToolDto.ts b/src/api/types/UpdateApiRequestToolDto.ts index 868b8a45..dd11fe7a 100644 --- a/src/api/types/UpdateApiRequestToolDto.ts +++ b/src/api/types/UpdateApiRequestToolDto.ts @@ -2,13 +2,19 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, and response handling. + */ export interface UpdateApiRequestToolDto { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.UpdateApiRequestToolDtoMessagesItem[] | undefined; /** - * These are the messages that will be spoken to the user as the tool is running. + * This is the name of the tool. This will be passed to the model. * - * 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. + * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40. */ - messages?: Vapi.UpdateApiRequestToolDtoMessagesItem[] | undefined; + name?: string | undefined; + /** The HTTP method used for the API request. */ method?: Vapi.UpdateApiRequestToolDtoMethod | undefined; /** * This is the timeout in seconds for the request. Defaults to 20 seconds. @@ -103,12 +109,6 @@ export interface UpdateApiRequestToolDto { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; - /** - * 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. - */ - name?: string | undefined; /** This is the description of the tool. This will be passed to the model. */ description?: string | undefined; /** This is where the request will be sent. */ diff --git a/src/api/types/UpdateApiRequestToolDtoMethod.ts b/src/api/types/UpdateApiRequestToolDtoMethod.ts index eb76c8ea..3b832638 100644 --- a/src/api/types/UpdateApiRequestToolDtoMethod.ts +++ b/src/api/types/UpdateApiRequestToolDtoMethod.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +/** The HTTP method used for the API request. */ export const UpdateApiRequestToolDtoMethod = { Post: "POST", Get: "GET", diff --git a/src/api/types/UpdateAssemblyAiCredentialDto.ts b/src/api/types/UpdateAssemblyAiCredentialDto.ts index 58818147..5aa15aea 100644 --- a/src/api/types/UpdateAssemblyAiCredentialDto.ts +++ b/src/api/types/UpdateAssemblyAiCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateAssemblyAiCredentialDto { + provider?: Vapi.UpdateAssemblyAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateAssemblyAiCredentialDtoProvider.ts b/src/api/types/UpdateAssemblyAiCredentialDtoProvider.ts new file mode 100644 index 00000000..4101401a --- /dev/null +++ b/src/api/types/UpdateAssemblyAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAssemblyAiCredentialDtoProvider = { + AssemblyAi: "assembly-ai", +} as const; +export type UpdateAssemblyAiCredentialDtoProvider = + (typeof UpdateAssemblyAiCredentialDtoProvider)[keyof typeof UpdateAssemblyAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateAssistantDraftDto.ts b/src/api/types/UpdateAssistantDraftDto.ts new file mode 100644 index 00000000..3b305816 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDto.ts @@ -0,0 +1,151 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface UpdateAssistantDraftDto { + /** These are the options for the assistant's transcriber. */ + transcriber?: Vapi.UpdateAssistantDraftDtoTranscriber | undefined; + /** These are the options for the assistant's LLM. */ + model?: Vapi.UpdateAssistantDraftDtoModel | undefined; + /** These are the options for the assistant's voice. */ + voice?: Vapi.UpdateAssistantDraftDtoVoice | undefined; + /** + * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). + * + * If unspecified, assistant will wait for user to speak and use the model to respond once they speak. + */ + firstMessage?: string | undefined; + firstMessageInterruptionsEnabled?: boolean | undefined; + /** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ + firstMessageMode?: Vapi.UpdateAssistantDraftDtoFirstMessageMode | undefined; + /** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ + voicemailDetection?: Vapi.UpdateAssistantDraftDtoVoicemailDetection | undefined; + /** These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started,assistant.started. You can check the shape of the messages in ClientMessage schema. */ + clientMessages?: Vapi.UpdateAssistantDraftDtoClientMessagesItem[] | undefined; + /** These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted,assistant.started. You can check the shape of the messages in ServerMessage schema. */ + serverMessages?: Vapi.UpdateAssistantDraftDtoServerMessagesItem[] | undefined; + /** + * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. + * + * @default 600 (10 minutes) + */ + maxDurationSeconds?: number | undefined; + /** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ + backgroundSound?: Vapi.UpdateAssistantDraftDtoBackgroundSound | undefined; + /** + * This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. + * + * @default false + */ + modelOutputInMessagesEnabled?: boolean | undefined; + /** These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used. */ + transportConfigurations?: Vapi.TransportConfigurationTwilio[] | undefined; + /** + * This is the plan for observability of assistant's calls. + * + * Currently, only Langfuse is supported. + */ + observabilityPlan?: Vapi.LangfuseObservabilityPlan | undefined; + /** These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials. */ + credentials?: Vapi.UpdateAssistantDraftDtoCredentialsItem[] | undefined; + /** This is a set of actions that will be performed on certain events. */ + hooks?: Vapi.UpdateAssistantDraftDtoHooksItem[] | undefined; + /** + * This is the name of the assistant. + * + * This is required when you want to transfer between assistants in a call. + */ + name?: string | undefined; + /** + * This is the message that the assistant will say if the call is forwarded to voicemail. + * + * If unspecified, it will hang up. + */ + voicemailMessage?: string | undefined; + /** + * This is the message that the assistant will say if it ends the call. + * + * If unspecified, it will hang up without saying anything. + */ + endCallMessage?: string | undefined; + /** This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive. */ + endCallPhrases?: string[] | undefined; + compliancePlan?: Vapi.CompliancePlan | undefined; + /** This is for metadata you want to store on the assistant. */ + metadata?: Record | undefined; + /** + * This enables filtering of noise and background speech while the user is talking. + * + * Features: + * - Smart denoising using Krisp + * - Fourier denoising + * + * Smart denoising can be combined with or used independently of Fourier denoising. + * + * Order of precedence: + * - Smart denoising + * - Fourier denoising + */ + backgroundSpeechDenoisingPlan?: Vapi.BackgroundSpeechDenoisingPlan | undefined; + /** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */ + analysisPlan?: Vapi.AnalysisPlan | undefined; + /** This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`. */ + artifactPlan?: Vapi.ArtifactPlan | undefined; + /** + * This is the plan for when the assistant should start talking. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to start talking after the customer is done speaking. + * - The assistant is too fast to start talking after the customer is done speaking. + * - The assistant is so fast that it's actually interrupting the customer. + */ + startSpeakingPlan?: Vapi.StartSpeakingPlan | undefined; + /** + * This is the plan for when assistant should stop talking on customer interruption. + * + * You should configure this if you're running into these issues: + * - The assistant is too slow to recognize customer's interruption. + * - The assistant is too fast to recognize customer's interruption. + * - The assistant is getting interrupted by phrases that are just acknowledgments. + * - The assistant is getting interrupted by background noises. + * - The assistant is not properly stopping -- it starts talking right after getting interrupted. + */ + stopSpeakingPlan?: Vapi.StopSpeakingPlan | undefined; + /** + * This is the plan for real-time monitoring of the assistant's calls. + * + * Usage: + * - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. + * - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`. + * - To attach monitors to the assistant, set `monitorPlan.monitorIds` to the set of monitor ids. + */ + monitorPlan?: Vapi.MonitorPlan | undefined; + /** These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this. */ + credentialIds?: string[] | undefined; + /** + * This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. + * + * The order of precedence is: + * + * 1. assistant.server.url + * 2. phoneNumber.serverUrl + * 3. org.serverUrl + */ + server?: Vapi.Server | undefined; + keypadInputPlan?: Vapi.KeypadInputPlan | undefined; +} diff --git a/src/api/types/UpdateAssistantDraftDtoBackgroundSound.ts b/src/api/types/UpdateAssistantDraftDtoBackgroundSound.ts new file mode 100644 index 00000000..58c9e15d --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoBackgroundSound.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. + * You can also provide a custom sound by providing a URL to an audio file. + */ +export type UpdateAssistantDraftDtoBackgroundSound = Vapi.UpdateAssistantDraftDtoBackgroundSoundZero | string; diff --git a/src/api/types/UpdateAssistantDraftDtoBackgroundSoundZero.ts b/src/api/types/UpdateAssistantDraftDtoBackgroundSoundZero.ts new file mode 100644 index 00000000..b0aea161 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoBackgroundSoundZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAssistantDraftDtoBackgroundSoundZero = { + Off: "off", + Office: "office", +} as const; +export type UpdateAssistantDraftDtoBackgroundSoundZero = + (typeof UpdateAssistantDraftDtoBackgroundSoundZero)[keyof typeof UpdateAssistantDraftDtoBackgroundSoundZero]; diff --git a/src/api/types/UpdateAssistantDraftDtoClientMessagesItem.ts b/src/api/types/UpdateAssistantDraftDtoClientMessagesItem.ts new file mode 100644 index 00000000..81c00529 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoClientMessagesItem.ts @@ -0,0 +1,25 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAssistantDraftDtoClientMessagesItem = { + ConversationUpdate: "conversation-update", + AssistantSpeechStarted: "assistant.speechStarted", + FunctionCall: "function-call", + FunctionCallResult: "function-call-result", + Hang: "hang", + LanguageChanged: "language-changed", + Metadata: "metadata", + ModelOutput: "model-output", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + ToolCalls: "tool-calls", + ToolCallsResult: "tool-calls-result", + ToolCompleted: "tool.completed", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + WorkflowNodeStarted: "workflow.node.started", + AssistantStarted: "assistant.started", +} as const; +export type UpdateAssistantDraftDtoClientMessagesItem = + (typeof UpdateAssistantDraftDtoClientMessagesItem)[keyof typeof UpdateAssistantDraftDtoClientMessagesItem]; diff --git a/src/api/types/UpdateAssistantDraftDtoCredentialsItem.ts b/src/api/types/UpdateAssistantDraftDtoCredentialsItem.ts new file mode 100644 index 00000000..dceb5add --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoCredentialsItem.ts @@ -0,0 +1,352 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type UpdateAssistantDraftDtoCredentialsItem = + | Vapi.UpdateAssistantDraftDtoCredentialsItem._11Labs + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Anthropic + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AnthropicBedrock + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Anyscale + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AssemblyAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AzureOpenai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Azure + | Vapi.UpdateAssistantDraftDtoCredentialsItem.ByoSipTrunk + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cartesia + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cerebras + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cloudflare + | Vapi.UpdateAssistantDraftDtoCredentialsItem.CustomLlm + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Deepgram + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Deepinfra + | Vapi.UpdateAssistantDraftDtoCredentialsItem.DeepSeek + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gcp + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gladia + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gohighlevel + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Google + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Groq + | Vapi.UpdateAssistantDraftDtoCredentialsItem.InflectionAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Langfuse + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Lmnt + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Make + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Openai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Openrouter + | Vapi.UpdateAssistantDraftDtoCredentialsItem.PerplexityAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Playht + | Vapi.UpdateAssistantDraftDtoCredentialsItem.RimeAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Runpod + | Vapi.UpdateAssistantDraftDtoCredentialsItem.S3 + | Vapi.UpdateAssistantDraftDtoCredentialsItem.S3Compatible + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Supabase + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SmallestAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Tavus + | Vapi.UpdateAssistantDraftDtoCredentialsItem.TogetherAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Twilio + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Vonage + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Webhook + | Vapi.UpdateAssistantDraftDtoCredentialsItem.CustomCredential + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Xai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Microsoft + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Neuphonic + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Hume + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Mistral + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Speechmatics + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Soniox + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SlackOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GhlOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Inworld + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Minimax + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Wellsaid + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Email + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SlackWebhook; + +export namespace UpdateAssistantDraftDtoCredentialsItem { + export interface _11Labs extends Vapi.CreateElevenLabsCredentialDto { + provider: "11labs"; + } + + export interface Anthropic extends Vapi.CreateAnthropicCredentialDto { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.CreateAnthropicBedrockCredentialDto { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.CreateAnyscaleCredentialDto { + provider: "anyscale"; + } + + export interface AssemblyAi extends Vapi.CreateAssemblyAiCredentialDto { + provider: "assembly-ai"; + } + + export interface AzureOpenai extends Vapi.CreateAzureOpenAiCredentialDto { + provider: "azure-openai"; + } + + export interface Azure extends Vapi.CreateAzureCredentialDto { + provider: "azure"; + } + + export interface ByoSipTrunk extends Vapi.CreateByoSipTrunkCredentialDto { + provider: "byo-sip-trunk"; + } + + export interface Cartesia extends Vapi.CreateCartesiaCredentialDto { + provider: "cartesia"; + } + + export interface Cerebras extends Vapi.CreateCerebrasCredentialDto { + provider: "cerebras"; + } + + export interface Cloudflare extends Vapi.CreateCloudflareCredentialDto { + provider: "cloudflare"; + } + + export interface CustomLlm extends Vapi.CreateCustomLlmCredentialDto { + provider: "custom-llm"; + } + + export interface Deepgram extends Vapi.CreateDeepgramCredentialDto { + provider: "deepgram"; + } + + export interface Deepinfra extends Vapi.CreateDeepInfraCredentialDto { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.CreateDeepSeekCredentialDto { + provider: "deep-seek"; + } + + export interface Gcp extends Vapi.CreateGcpCredentialDto { + provider: "gcp"; + } + + export interface Gladia extends Vapi.CreateGladiaCredentialDto { + provider: "gladia"; + } + + export interface Gohighlevel extends Vapi.CreateGoHighLevelCredentialDto { + provider: "gohighlevel"; + } + + export interface Google extends Vapi.CreateGoogleCredentialDto { + provider: "google"; + } + + export interface Groq extends Vapi.CreateGroqCredentialDto { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.CreateInflectionAiCredentialDto { + provider: "inflection-ai"; + } + + export interface Langfuse extends Vapi.CreateLangfuseCredentialDto { + provider: "langfuse"; + } + + export interface Lmnt extends Vapi.CreateLmntCredentialDto { + provider: "lmnt"; + } + + export interface Make extends Vapi.CreateMakeCredentialDto { + provider: "make"; + } + + export interface Openai extends Vapi.CreateOpenAiCredentialDto { + provider: "openai"; + } + + export interface Openrouter extends Vapi.CreateOpenRouterCredentialDto { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.CreatePerplexityAiCredentialDto { + provider: "perplexity-ai"; + } + + export interface Playht extends Vapi.CreatePlayHtCredentialDto { + provider: "playht"; + } + + export interface RimeAi extends Vapi.CreateRimeAiCredentialDto { + provider: "rime-ai"; + } + + export interface Runpod extends Vapi.CreateRunpodCredentialDto { + provider: "runpod"; + } + + export interface S3 extends Vapi.CreateS3CredentialDto { + provider: "s3"; + } + + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { + provider: "supabase"; + } + + export interface SmallestAi extends Vapi.CreateSmallestAiCredentialDto { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.CreateTavusCredentialDto { + provider: "tavus"; + } + + export interface TogetherAi extends Vapi.CreateTogetherAiCredentialDto { + provider: "together-ai"; + } + + export interface Twilio extends Vapi.CreateTwilioCredentialDto { + provider: "twilio"; + } + + export interface Vonage extends Vapi.CreateVonageCredentialDto { + provider: "vonage"; + } + + export interface Webhook extends Vapi.CreateWebhookCredentialDto { + provider: "webhook"; + } + + export interface CustomCredential extends Vapi.CreateCustomCredentialDto { + provider: "custom-credential"; + } + + export interface Xai extends Vapi.CreateXAiCredentialDto { + provider: "xai"; + } + + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { + provider: "neuphonic"; + } + + export interface Hume extends Vapi.CreateHumeCredentialDto { + provider: "hume"; + } + + export interface Mistral extends Vapi.CreateMistralCredentialDto { + provider: "mistral"; + } + + export interface Speechmatics extends Vapi.CreateSpeechmaticsCredentialDto { + provider: "speechmatics"; + } + + export interface Soniox extends Vapi.CreateSonioxCredentialDto { + provider: "soniox"; + } + + export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { + provider: "google.calendar.oauth2-client"; + } + + export interface GoogleCalendarOauth2Authorization + extends Vapi.CreateGoogleCalendarOAuth2AuthorizationCredentialDto { + provider: "google.calendar.oauth2-authorization"; + } + + export interface GoogleSheetsOauth2Authorization extends Vapi.CreateGoogleSheetsOAuth2AuthorizationCredentialDto { + provider: "google.sheets.oauth2-authorization"; + } + + export interface SlackOauth2Authorization extends Vapi.CreateSlackOAuth2AuthorizationCredentialDto { + provider: "slack.oauth2-authorization"; + } + + export interface GhlOauth2Authorization extends Vapi.CreateGoHighLevelMcpCredentialDto { + provider: "ghl.oauth2-authorization"; + } + + export interface Inworld extends Vapi.CreateInworldCredentialDto { + provider: "inworld"; + } + + export interface Minimax extends Vapi.CreateMinimaxCredentialDto { + provider: "minimax"; + } + + export interface Wellsaid extends Vapi.CreateWellSaidCredentialDto { + provider: "wellsaid"; + } + + export interface Email extends Vapi.CreateEmailCredentialDto { + provider: "email"; + } + + export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { + provider: "slack-webhook"; + } + + export type Response = + | Vapi.UpdateAssistantDraftDtoCredentialsItem._11Labs + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Anthropic + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AnthropicBedrock + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Anyscale + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AssemblyAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.AzureOpenai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Azure + | Vapi.UpdateAssistantDraftDtoCredentialsItem.ByoSipTrunk + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cartesia + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cerebras + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Cloudflare + | Vapi.UpdateAssistantDraftDtoCredentialsItem.CustomLlm + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Deepgram + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Deepinfra + | Vapi.UpdateAssistantDraftDtoCredentialsItem.DeepSeek + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gcp + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gladia + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Gohighlevel + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Google + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Groq + | Vapi.UpdateAssistantDraftDtoCredentialsItem.InflectionAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Langfuse + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Lmnt + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Make + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Openai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Openrouter + | Vapi.UpdateAssistantDraftDtoCredentialsItem.PerplexityAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Playht + | Vapi.UpdateAssistantDraftDtoCredentialsItem.RimeAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Runpod + | Vapi.UpdateAssistantDraftDtoCredentialsItem.S3 + | Vapi.UpdateAssistantDraftDtoCredentialsItem.S3Compatible + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Supabase + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SmallestAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Tavus + | Vapi.UpdateAssistantDraftDtoCredentialsItem.TogetherAi + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Twilio + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Vonage + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Webhook + | Vapi.UpdateAssistantDraftDtoCredentialsItem.CustomCredential + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Xai + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Microsoft + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Neuphonic + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Hume + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Mistral + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Speechmatics + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Soniox + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SlackOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.GhlOauth2Authorization + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Inworld + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Minimax + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Wellsaid + | Vapi.UpdateAssistantDraftDtoCredentialsItem.Email + | Vapi.UpdateAssistantDraftDtoCredentialsItem.SlackWebhook; +} diff --git a/src/api/types/UpdateAssistantDraftDtoFirstMessageMode.ts b/src/api/types/UpdateAssistantDraftDtoFirstMessageMode.ts new file mode 100644 index 00000000..0cfc3b0b --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoFirstMessageMode.ts @@ -0,0 +1,19 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the mode for the first message. Default is 'assistant-speaks-first'. + * + * Use: + * - 'assistant-speaks-first' to have the assistant speak first. + * - 'assistant-waits-for-user' to have the assistant wait for the user to speak first. + * - 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points). + * + * @default 'assistant-speaks-first' + */ +export const UpdateAssistantDraftDtoFirstMessageMode = { + AssistantSpeaksFirst: "assistant-speaks-first", + AssistantSpeaksFirstWithModelGeneratedMessage: "assistant-speaks-first-with-model-generated-message", + AssistantWaitsForUser: "assistant-waits-for-user", +} as const; +export type UpdateAssistantDraftDtoFirstMessageMode = + (typeof UpdateAssistantDraftDtoFirstMessageMode)[keyof typeof UpdateAssistantDraftDtoFirstMessageMode]; diff --git a/src/api/types/UpdateAssistantDraftDtoHooksItem.ts b/src/api/types/UpdateAssistantDraftDtoHooksItem.ts new file mode 100644 index 00000000..3a8160ba --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoHooksItem.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type UpdateAssistantDraftDtoHooksItem = + | Vapi.CallHookCallEnding + | Vapi.CallHookAssistantSpeechInterrupted + | Vapi.CallHookCustomerSpeechInterrupted + | Vapi.CallHookCustomerSpeechTimeout + | Vapi.SessionCreatedHook; diff --git a/src/api/types/UpdateAssistantDraftDtoModel.ts b/src/api/types/UpdateAssistantDraftDtoModel.ts new file mode 100644 index 00000000..53f5bca1 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoModel.ts @@ -0,0 +1,117 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's LLM. + */ +export type UpdateAssistantDraftDtoModel = + | Vapi.UpdateAssistantDraftDtoModel.Anthropic + | Vapi.UpdateAssistantDraftDtoModel.AnthropicBedrock + | Vapi.UpdateAssistantDraftDtoModel.Anyscale + | Vapi.UpdateAssistantDraftDtoModel.Cerebras + | Vapi.UpdateAssistantDraftDtoModel.CustomLlm + | Vapi.UpdateAssistantDraftDtoModel.Deepinfra + | Vapi.UpdateAssistantDraftDtoModel.DeepSeek + | Vapi.UpdateAssistantDraftDtoModel.Google + | Vapi.UpdateAssistantDraftDtoModel.Groq + | Vapi.UpdateAssistantDraftDtoModel.InflectionAi + | Vapi.UpdateAssistantDraftDtoModel.Minimax + | Vapi.UpdateAssistantDraftDtoModel.Openai + | Vapi.UpdateAssistantDraftDtoModel.Openrouter + | Vapi.UpdateAssistantDraftDtoModel.PerplexityAi + | Vapi.UpdateAssistantDraftDtoModel.TogetherAi + | Vapi.UpdateAssistantDraftDtoModel.Xai + | Vapi.UpdateAssistantDraftDtoModel.Vapi; + +export namespace UpdateAssistantDraftDtoModel { + export interface Anthropic extends Vapi.AnthropicModel { + provider: "anthropic"; + } + + export interface AnthropicBedrock extends Vapi.AnthropicBedrockModel { + provider: "anthropic-bedrock"; + } + + export interface Anyscale extends Vapi.AnyscaleModel { + provider: "anyscale"; + } + + export interface Cerebras extends Vapi.CerebrasModel { + provider: "cerebras"; + } + + export interface CustomLlm extends Vapi.CustomLlmModel { + provider: "custom-llm"; + } + + export interface Deepinfra extends Vapi.DeepInfraModel { + provider: "deepinfra"; + } + + export interface DeepSeek extends Vapi.DeepSeekModel { + provider: "deep-seek"; + } + + export interface Google extends Vapi.GoogleModel { + provider: "google"; + } + + export interface Groq extends Vapi.GroqModel { + provider: "groq"; + } + + export interface InflectionAi extends Vapi.InflectionAiModel { + provider: "inflection-ai"; + } + + export interface Minimax extends Vapi.MinimaxLlmModel { + provider: "minimax"; + } + + export interface Openai extends Vapi.OpenAiModel { + provider: "openai"; + } + + export interface Openrouter extends Vapi.OpenRouterModel { + provider: "openrouter"; + } + + export interface PerplexityAi extends Vapi.PerplexityAiModel { + provider: "perplexity-ai"; + } + + export interface TogetherAi extends Vapi.TogetherAiModel { + provider: "together-ai"; + } + + export interface Xai extends Vapi.XaiModel { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiModel { + provider: "vapi"; + } + + /** + * These are the options for the assistant's LLM. + */ + export type Response = + | Vapi.UpdateAssistantDraftDtoModel.Anthropic + | Vapi.UpdateAssistantDraftDtoModel.AnthropicBedrock + | Vapi.UpdateAssistantDraftDtoModel.Anyscale + | Vapi.UpdateAssistantDraftDtoModel.Cerebras + | Vapi.UpdateAssistantDraftDtoModel.CustomLlm + | Vapi.UpdateAssistantDraftDtoModel.Deepinfra + | Vapi.UpdateAssistantDraftDtoModel.DeepSeek + | Vapi.UpdateAssistantDraftDtoModel.Google + | Vapi.UpdateAssistantDraftDtoModel.Groq + | Vapi.UpdateAssistantDraftDtoModel.InflectionAi + | Vapi.UpdateAssistantDraftDtoModel.Minimax + | Vapi.UpdateAssistantDraftDtoModel.Openai + | Vapi.UpdateAssistantDraftDtoModel.Openrouter + | Vapi.UpdateAssistantDraftDtoModel.PerplexityAi + | Vapi.UpdateAssistantDraftDtoModel.TogetherAi + | Vapi.UpdateAssistantDraftDtoModel.Xai + | Vapi.UpdateAssistantDraftDtoModel.Vapi; +} diff --git a/src/api/types/UpdateAssistantDraftDtoServerMessagesItem.ts b/src/api/types/UpdateAssistantDraftDtoServerMessagesItem.ts new file mode 100644 index 00000000..2b9291fb --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoServerMessagesItem.ts @@ -0,0 +1,34 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAssistantDraftDtoServerMessagesItem = { + AssistantStarted: "assistant.started", + AssistantSpeechStarted: "assistant.speechStarted", + ConversationUpdate: "conversation-update", + EndOfCallReport: "end-of-call-report", + FunctionCall: "function-call", + Hang: "hang", + LanguageChanged: "language-changed", + LanguageChangeDetected: "language-change-detected", + ModelOutput: "model-output", + PhoneCallControl: "phone-call-control", + SpeechUpdate: "speech-update", + StatusUpdate: "status-update", + Transcript: "transcript", + TranscriptTranscriptTypeFinal: 'transcript[transcriptType="final"]', + ToolCalls: "tool-calls", + TransferDestinationRequest: "transfer-destination-request", + HandoffDestinationRequest: "handoff-destination-request", + TransferUpdate: "transfer-update", + UserInterrupted: "user-interrupted", + VoiceInput: "voice-input", + ChatCreated: "chat.created", + ChatDeleted: "chat.deleted", + SessionCreated: "session.created", + SessionUpdated: "session.updated", + SessionDeleted: "session.deleted", + CallDeleted: "call.deleted", + CallDeleteFailed: "call.delete.failed", + CallArtifactUpload: "call.artifact.upload", +} as const; +export type UpdateAssistantDraftDtoServerMessagesItem = + (typeof UpdateAssistantDraftDtoServerMessagesItem)[keyof typeof UpdateAssistantDraftDtoServerMessagesItem]; diff --git a/src/api/types/UpdateAssistantDraftDtoTranscriber.ts b/src/api/types/UpdateAssistantDraftDtoTranscriber.ts new file mode 100644 index 00000000..516448af --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoTranscriber.ts @@ -0,0 +1,80 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's transcriber. + */ +export type UpdateAssistantDraftDtoTranscriber = + | Vapi.UpdateAssistantDraftDtoTranscriber.AssemblyAi + | Vapi.UpdateAssistantDraftDtoTranscriber.Azure + | Vapi.UpdateAssistantDraftDtoTranscriber.CustomTranscriber + | Vapi.UpdateAssistantDraftDtoTranscriber.Deepgram + | Vapi.UpdateAssistantDraftDtoTranscriber._11Labs + | Vapi.UpdateAssistantDraftDtoTranscriber.Gladia + | Vapi.UpdateAssistantDraftDtoTranscriber.Google + | Vapi.UpdateAssistantDraftDtoTranscriber.Speechmatics + | Vapi.UpdateAssistantDraftDtoTranscriber.Talkscriber + | Vapi.UpdateAssistantDraftDtoTranscriber.Openai + | Vapi.UpdateAssistantDraftDtoTranscriber.Cartesia + | Vapi.UpdateAssistantDraftDtoTranscriber.Soniox + | Vapi.UpdateAssistantDraftDtoTranscriber.Xai + | Vapi.UpdateAssistantDraftDtoTranscriber.Vapi; + +export namespace UpdateAssistantDraftDtoTranscriber { + export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { + provider: "assembly-ai"; + } + + export interface Azure extends Vapi.AzureSpeechTranscriber { + provider: "azure"; + } + + export interface CustomTranscriber extends Vapi.CustomTranscriber { + provider: "custom-transcriber"; + } + + export interface Deepgram extends Vapi.DeepgramTranscriber { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsTranscriber { + provider: "11labs"; + } + + export interface Gladia extends Vapi.GladiaTranscriber { + provider: "gladia"; + } + + export interface Google extends Vapi.GoogleTranscriber { + provider: "google"; + } + + export interface Speechmatics extends Vapi.SpeechmaticsTranscriber { + provider: "speechmatics"; + } + + export interface Talkscriber extends Vapi.TalkscriberTranscriber { + provider: "talkscriber"; + } + + export interface Openai extends Vapi.OpenAiTranscriber { + provider: "openai"; + } + + export interface Cartesia extends Vapi.CartesiaTranscriber { + provider: "cartesia"; + } + + export interface Soniox extends Vapi.SonioxTranscriber { + provider: "soniox"; + } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } +} diff --git a/src/api/types/UpdateAssistantDraftDtoVoice.ts b/src/api/types/UpdateAssistantDraftDtoVoice.ts new file mode 100644 index 00000000..f1f7ad87 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoVoice.ts @@ -0,0 +1,110 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the options for the assistant's voice. + */ +export type UpdateAssistantDraftDtoVoice = + | Vapi.UpdateAssistantDraftDtoVoice.Azure + | Vapi.UpdateAssistantDraftDtoVoice.Cartesia + | Vapi.UpdateAssistantDraftDtoVoice.CustomVoice + | Vapi.UpdateAssistantDraftDtoVoice.Deepgram + | Vapi.UpdateAssistantDraftDtoVoice._11Labs + | Vapi.UpdateAssistantDraftDtoVoice.Hume + | Vapi.UpdateAssistantDraftDtoVoice.Lmnt + | Vapi.UpdateAssistantDraftDtoVoice.Neuphonic + | Vapi.UpdateAssistantDraftDtoVoice.Openai + | Vapi.UpdateAssistantDraftDtoVoice.Playht + | Vapi.UpdateAssistantDraftDtoVoice.Wellsaid + | Vapi.UpdateAssistantDraftDtoVoice.RimeAi + | Vapi.UpdateAssistantDraftDtoVoice.SmallestAi + | Vapi.UpdateAssistantDraftDtoVoice.Tavus + | Vapi.UpdateAssistantDraftDtoVoice.Vapi + | Vapi.UpdateAssistantDraftDtoVoice.Sesame + | Vapi.UpdateAssistantDraftDtoVoice.Inworld + | Vapi.UpdateAssistantDraftDtoVoice.Minimax + | Vapi.UpdateAssistantDraftDtoVoice.Xai + | Vapi.UpdateAssistantDraftDtoVoice.Microsoft; + +export namespace UpdateAssistantDraftDtoVoice { + export interface Azure extends Vapi.AzureVoice { + provider: "azure"; + } + + export interface Cartesia extends Vapi.CartesiaVoice { + provider: "cartesia"; + } + + export interface CustomVoice extends Vapi.CustomVoice { + provider: "custom-voice"; + } + + export interface Deepgram extends Vapi.DeepgramVoice { + provider: "deepgram"; + } + + export interface _11Labs extends Vapi.ElevenLabsVoice { + provider: "11labs"; + } + + export interface Hume extends Vapi.HumeVoice { + provider: "hume"; + } + + export interface Lmnt extends Vapi.LmntVoice { + provider: "lmnt"; + } + + export interface Neuphonic extends Vapi.NeuphonicVoice { + provider: "neuphonic"; + } + + export interface Openai extends Vapi.OpenAiVoice { + provider: "openai"; + } + + export interface Playht extends Vapi.PlayHtVoice { + provider: "playht"; + } + + export interface Wellsaid extends Vapi.WellSaidVoice { + provider: "wellsaid"; + } + + export interface RimeAi extends Vapi.RimeAiVoice { + provider: "rime-ai"; + } + + export interface SmallestAi extends Vapi.SmallestAiVoice { + provider: "smallest-ai"; + } + + export interface Tavus extends Vapi.TavusVoice { + provider: "tavus"; + } + + export interface Vapi extends Vapi.VapiVoice { + provider: "vapi"; + } + + export interface Sesame extends Vapi.SesameVoice { + provider: "sesame"; + } + + export interface Inworld extends Vapi.InworldVoice { + provider: "inworld"; + } + + export interface Minimax extends Vapi.MinimaxVoice { + provider: "minimax"; + } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } +} diff --git a/src/api/types/UpdateAssistantDraftDtoVoicemailDetection.ts b/src/api/types/UpdateAssistantDraftDtoVoicemailDetection.ts new file mode 100644 index 00000000..bb68cfa4 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoVoicemailDetection.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +/** + * These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. + * By default, voicemail detection is disabled. + */ +export type UpdateAssistantDraftDtoVoicemailDetection = + | Vapi.UpdateAssistantDraftDtoVoicemailDetectionZero + | Vapi.GoogleVoicemailDetectionPlan + | Vapi.OpenAiVoicemailDetectionPlan + | Vapi.TwilioVoicemailDetectionPlan + | Vapi.VapiVoicemailDetectionPlan; diff --git a/src/api/types/UpdateAssistantDraftDtoVoicemailDetectionZero.ts b/src/api/types/UpdateAssistantDraftDtoVoicemailDetectionZero.ts new file mode 100644 index 00000000..8d60d043 --- /dev/null +++ b/src/api/types/UpdateAssistantDraftDtoVoicemailDetectionZero.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAssistantDraftDtoVoicemailDetectionZero = { + Off: "off", +} as const; +export type UpdateAssistantDraftDtoVoicemailDetectionZero = + (typeof UpdateAssistantDraftDtoVoicemailDetectionZero)[keyof typeof UpdateAssistantDraftDtoVoicemailDetectionZero]; diff --git a/src/api/types/UpdateAssistantVersionMetadataDto.ts b/src/api/types/UpdateAssistantVersionMetadataDto.ts new file mode 100644 index 00000000..7b80a20c --- /dev/null +++ b/src/api/types/UpdateAssistantVersionMetadataDto.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface UpdateAssistantVersionMetadataDto { + /** Optional human-readable label for this version. Pass `null` to clear. */ + versionName?: (string | null) | undefined; + /** Optional description for this version. Pass `null` to clear. */ + versionDescription?: (string | null) | undefined; +} diff --git a/src/api/types/UpdateAzureCredentialDto.ts b/src/api/types/UpdateAzureCredentialDto.ts index 9bf7edff..be598005 100644 --- a/src/api/types/UpdateAzureCredentialDto.ts +++ b/src/api/types/UpdateAzureCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateAzureCredentialDto { + provider?: Vapi.UpdateAzureCredentialDtoProvider | undefined; /** This is the service being used in Azure. */ service?: Vapi.UpdateAzureCredentialDtoService | undefined; /** This is the region of the Azure resource. */ diff --git a/src/api/types/UpdateAzureCredentialDtoProvider.ts b/src/api/types/UpdateAzureCredentialDtoProvider.ts new file mode 100644 index 00000000..f8362efa --- /dev/null +++ b/src/api/types/UpdateAzureCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAzureCredentialDtoProvider = { + Azure: "azure", +} as const; +export type UpdateAzureCredentialDtoProvider = + (typeof UpdateAzureCredentialDtoProvider)[keyof typeof UpdateAzureCredentialDtoProvider]; diff --git a/src/api/types/UpdateAzureCredentialDtoRegion.ts b/src/api/types/UpdateAzureCredentialDtoRegion.ts index 3984aa53..135cbba9 100644 --- a/src/api/types/UpdateAzureCredentialDtoRegion.ts +++ b/src/api/types/UpdateAzureCredentialDtoRegion.ts @@ -20,6 +20,8 @@ export const UpdateAzureCredentialDtoRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/UpdateAzureOpenAiCredentialDto.ts b/src/api/types/UpdateAzureOpenAiCredentialDto.ts index df266535..e8fa7548 100644 --- a/src/api/types/UpdateAzureOpenAiCredentialDto.ts +++ b/src/api/types/UpdateAzureOpenAiCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateAzureOpenAiCredentialDto { + provider?: Vapi.UpdateAzureOpenAiCredentialDtoProvider | undefined; region?: Vapi.UpdateAzureOpenAiCredentialDtoRegion | undefined; models?: Vapi.UpdateAzureOpenAiCredentialDtoModelsItem[] | undefined; /** This is not returned in the API. */ diff --git a/src/api/types/UpdateAzureOpenAiCredentialDtoModelsItem.ts b/src/api/types/UpdateAzureOpenAiCredentialDtoModelsItem.ts index e310e543..0e2f0488 100644 --- a/src/api/types/UpdateAzureOpenAiCredentialDtoModelsItem.ts +++ b/src/api/types/UpdateAzureOpenAiCredentialDtoModelsItem.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. export const UpdateAzureOpenAiCredentialDtoModelsItem = { + Gpt56Luna20260709: "gpt-5.6-luna-2026-07-09", + Gpt56Terra20260709: "gpt-5.6-terra-2026-07-09", + Gpt56Sol20260709: "gpt-5.6-sol-2026-07-09", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -24,6 +27,9 @@ export const UpdateAzureOpenAiCredentialDtoModelsItem = { Gpt40613: "gpt-4-0613", Gpt35Turbo0125: "gpt-35-turbo-0125", Gpt35Turbo1106: "gpt-35-turbo-1106", + Gpt4O: "gpt-4o", + Gpt41: "gpt-4.1", + Gpt54Mini20260317: "gpt-5.4-mini-2026-03-17", } as const; export type UpdateAzureOpenAiCredentialDtoModelsItem = (typeof UpdateAzureOpenAiCredentialDtoModelsItem)[keyof typeof UpdateAzureOpenAiCredentialDtoModelsItem]; diff --git a/src/api/types/UpdateAzureOpenAiCredentialDtoProvider.ts b/src/api/types/UpdateAzureOpenAiCredentialDtoProvider.ts new file mode 100644 index 00000000..2b11282f --- /dev/null +++ b/src/api/types/UpdateAzureOpenAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateAzureOpenAiCredentialDtoProvider = { + AzureOpenai: "azure-openai", +} as const; +export type UpdateAzureOpenAiCredentialDtoProvider = + (typeof UpdateAzureOpenAiCredentialDtoProvider)[keyof typeof UpdateAzureOpenAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateAzureOpenAiCredentialDtoRegion.ts b/src/api/types/UpdateAzureOpenAiCredentialDtoRegion.ts index bd3b57fe..f4be1a0d 100644 --- a/src/api/types/UpdateAzureOpenAiCredentialDtoRegion.ts +++ b/src/api/types/UpdateAzureOpenAiCredentialDtoRegion.ts @@ -19,6 +19,8 @@ export const UpdateAzureOpenAiCredentialDtoRegion = { Spaincentral: "spaincentral", Swedencentral: "swedencentral", Switzerland: "switzerland", + Switzerlandnorth: "switzerlandnorth", + Switzerlandwest: "switzerlandwest", Uaenorth: "uaenorth", Uk: "uk", Westeurope: "westeurope", diff --git a/src/api/types/UpdateBarInsightFromCallTableDto.ts b/src/api/types/UpdateBarInsightFromCallTableDto.ts index a0cc7baa..3b002ad7 100644 --- a/src/api/types/UpdateBarInsightFromCallTableDto.ts +++ b/src/api/types/UpdateBarInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ export interface UpdateBarInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface UpdateBarInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.BarInsightMetadata | undefined; + /** The time range and interval used to aggregate the bar-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdateBashToolDto.ts b/src/api/types/UpdateBashToolDto.ts index 8aa76fae..79713306 100644 --- a/src/api/types/UpdateBashToolDto.ts +++ b/src/api/types/UpdateBashToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan. + */ export interface UpdateBashToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateBashToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType?: Vapi.UpdateBashToolDtoSubType | undefined; diff --git a/src/api/types/UpdateByoPhoneNumberDto.ts b/src/api/types/UpdateByoPhoneNumberDto.ts index fbdaef7b..ae6d13e5 100644 --- a/src/api/types/UpdateByoPhoneNumberDto.ts +++ b/src/api/types/UpdateByoPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateByoPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateByoSipTrunkCredentialDto.ts b/src/api/types/UpdateByoSipTrunkCredentialDto.ts index 858120a2..eac8f95e 100644 --- a/src/api/types/UpdateByoSipTrunkCredentialDto.ts +++ b/src/api/types/UpdateByoSipTrunkCredentialDto.ts @@ -3,6 +3,8 @@ import type * as Vapi from "../index.js"; export interface UpdateByoSipTrunkCredentialDto { + /** This can be used to bring your own SIP trunks or to connect to a Carrier. */ + provider?: Vapi.UpdateByoSipTrunkCredentialDtoProvider | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; /** This is the list of SIP trunk's gateways. */ @@ -22,6 +24,4 @@ export interface UpdateByoSipTrunkCredentialDto { techPrefix?: string | undefined; /** This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property. */ sipDiversionHeader?: string | undefined; - /** This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi. */ - sbcConfiguration?: Vapi.SbcConfiguration | undefined; } diff --git a/src/api/types/UpdateByoSipTrunkCredentialDtoProvider.ts b/src/api/types/UpdateByoSipTrunkCredentialDtoProvider.ts new file mode 100644 index 00000000..6a8f2f3a --- /dev/null +++ b/src/api/types/UpdateByoSipTrunkCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This can be used to bring your own SIP trunks or to connect to a Carrier. */ +export const UpdateByoSipTrunkCredentialDtoProvider = { + ByoSipTrunk: "byo-sip-trunk", +} as const; +export type UpdateByoSipTrunkCredentialDtoProvider = + (typeof UpdateByoSipTrunkCredentialDtoProvider)[keyof typeof UpdateByoSipTrunkCredentialDtoProvider]; diff --git a/src/api/resources/campaigns/client/requests/UpdateCampaignDto.ts b/src/api/types/UpdateCampaignDto.ts similarity index 65% rename from src/api/resources/campaigns/client/requests/UpdateCampaignDto.ts rename to src/api/types/UpdateCampaignDto.ts index 03f7e377..600e12d2 100644 --- a/src/api/resources/campaigns/client/requests/UpdateCampaignDto.ts +++ b/src/api/types/UpdateCampaignDto.ts @@ -1,49 +1,44 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../../../../index.js"; +import type * as Vapi from "../index.js"; /** - * @example - * { - * id: "id" - * } + * Fields used to update an outbound calling campaign, including its name, status, calling resource, phone-number or dial-plan settings, and schedule. */ export interface UpdateCampaignDto { - id: string; /** This is the name of the campaign. This is just for your own reference. */ - name?: string; + name?: string | undefined; /** * This is the assistant ID that will be used for the campaign calls. * Can only be updated if campaign is not in progress or has ended. */ - assistantId?: string; + assistantId?: string | undefined; /** * This is the workflow ID that will be used for the campaign calls. * Can only be updated if campaign is not in progress or has ended. */ - workflowId?: string; + workflowId?: string | undefined; /** * This is the squad ID that will be used for the campaign calls. * Can only be updated if campaign is not in progress or has ended. */ - squadId?: string; + squadId?: string | undefined; /** * This is the phone number ID that will be used for the campaign calls. * Can only be updated if campaign is not in progress or has ended. * Note: `phoneNumberId` and `dialPlan` are mutually exclusive. */ - phoneNumberId?: string; + phoneNumberId?: string | undefined; /** This is a list of dial entries, each specifying a phone number and the customers to call using that number. Can only be updated if campaign is not in progress or has ended. Note: phoneNumberId and dialPlan are mutually exclusive. */ - dialPlan?: Vapi.DialPlanEntry[]; + dialPlan?: Vapi.DialPlanEntry[] | undefined; /** * This is the schedule plan for the campaign. * Can only be updated if campaign is not in progress or has ended. */ - schedulePlan?: Vapi.SchedulePlan; + schedulePlan?: Vapi.SchedulePlan | undefined; /** - * This is the status of the campaign. - * Can only be updated to 'ended' if you want to end the campaign. - * When set to 'ended', it will delete all scheduled calls. Calls in progress will be allowed to complete. + * Set to 'cancelled' to stop the campaign ('ended' is a V1 alias). Scheduled + * calls are deleted; in-progress calls are allowed to finish. */ - status?: Vapi.UpdateCampaignDtoStatus; + status?: Vapi.UpdateCampaignDtoStatus | undefined; } diff --git a/src/api/resources/campaigns/types/UpdateCampaignDtoStatus.ts b/src/api/types/UpdateCampaignDtoStatus.ts similarity index 54% rename from src/api/resources/campaigns/types/UpdateCampaignDtoStatus.ts rename to src/api/types/UpdateCampaignDtoStatus.ts index 3da73eaa..100b3f39 100644 --- a/src/api/resources/campaigns/types/UpdateCampaignDtoStatus.ts +++ b/src/api/types/UpdateCampaignDtoStatus.ts @@ -1,11 +1,11 @@ // This file was auto-generated by Fern from our API Definition. /** - * This is the status of the campaign. - * Can only be updated to 'ended' if you want to end the campaign. - * When set to 'ended', it will delete all scheduled calls. Calls in progress will be allowed to complete. + * Set to 'cancelled' to stop the campaign ('ended' is a V1 alias). Scheduled + * calls are deleted; in-progress calls are allowed to finish. */ export const UpdateCampaignDtoStatus = { Ended: "ended", + Cancelled: "cancelled", } as const; export type UpdateCampaignDtoStatus = (typeof UpdateCampaignDtoStatus)[keyof typeof UpdateCampaignDtoStatus]; diff --git a/src/api/types/UpdateCartesiaCredentialDto.ts b/src/api/types/UpdateCartesiaCredentialDto.ts index c6aa895f..2bae0ea3 100644 --- a/src/api/types/UpdateCartesiaCredentialDto.ts +++ b/src/api/types/UpdateCartesiaCredentialDto.ts @@ -1,8 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateCartesiaCredentialDto { + provider?: Vapi.UpdateCartesiaCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; + /** This can be used to point to an onprem Cartesia instance. Defaults to api.cartesia.ai. */ + apiUrl?: string | undefined; } diff --git a/src/api/types/UpdateCartesiaCredentialDtoProvider.ts b/src/api/types/UpdateCartesiaCredentialDtoProvider.ts new file mode 100644 index 00000000..9cbc21ac --- /dev/null +++ b/src/api/types/UpdateCartesiaCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateCartesiaCredentialDtoProvider = { + Cartesia: "cartesia", +} as const; +export type UpdateCartesiaCredentialDtoProvider = + (typeof UpdateCartesiaCredentialDtoProvider)[keyof typeof UpdateCartesiaCredentialDtoProvider]; diff --git a/src/api/types/UpdateCerebrasCredentialDto.ts b/src/api/types/UpdateCerebrasCredentialDto.ts index 177ea79d..e576461a 100644 --- a/src/api/types/UpdateCerebrasCredentialDto.ts +++ b/src/api/types/UpdateCerebrasCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateCerebrasCredentialDto { + provider?: Vapi.UpdateCerebrasCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateCerebrasCredentialDtoProvider.ts b/src/api/types/UpdateCerebrasCredentialDtoProvider.ts new file mode 100644 index 00000000..467425ae --- /dev/null +++ b/src/api/types/UpdateCerebrasCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateCerebrasCredentialDtoProvider = { + Cerebras: "cerebras", +} as const; +export type UpdateCerebrasCredentialDtoProvider = + (typeof UpdateCerebrasCredentialDtoProvider)[keyof typeof UpdateCerebrasCredentialDtoProvider]; diff --git a/src/api/types/UpdateCloudflareCredentialDto.ts b/src/api/types/UpdateCloudflareCredentialDto.ts index d389f5bb..aa46082d 100644 --- a/src/api/types/UpdateCloudflareCredentialDto.ts +++ b/src/api/types/UpdateCloudflareCredentialDto.ts @@ -3,6 +3,8 @@ import type * as Vapi from "../index.js"; export interface UpdateCloudflareCredentialDto { + /** Credential provider. Only allowed value is cloudflare */ + provider?: Vapi.UpdateCloudflareCredentialDtoProvider | undefined; /** Cloudflare Account Id. */ accountId?: string | undefined; /** Cloudflare API Key / Token. */ diff --git a/src/api/types/UpdateCloudflareCredentialDtoProvider.ts b/src/api/types/UpdateCloudflareCredentialDtoProvider.ts new file mode 100644 index 00000000..a96ea18c --- /dev/null +++ b/src/api/types/UpdateCloudflareCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Credential provider. Only allowed value is cloudflare */ +export const UpdateCloudflareCredentialDtoProvider = { + Cloudflare: "cloudflare", +} as const; +export type UpdateCloudflareCredentialDtoProvider = + (typeof UpdateCloudflareCredentialDtoProvider)[keyof typeof UpdateCloudflareCredentialDtoProvider]; diff --git a/src/api/types/UpdateCodeToolDto.ts b/src/api/types/UpdateCodeToolDto.ts index b1eccc1a..8fb989a8 100644 --- a/src/api/types/UpdateCodeToolDto.ts +++ b/src/api/types/UpdateCodeToolDto.ts @@ -3,12 +3,10 @@ import type * as Vapi from "../index.js"; export interface UpdateCodeToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateCodeToolDtoMessagesItem[] | undefined; + /** The type of tool. "code" for Code tool. */ + type?: Vapi.UpdateCodeToolDtoType | undefined; /** * This determines if the tool is async. * diff --git a/src/api/types/UpdateCodeToolDtoType.ts b/src/api/types/UpdateCodeToolDtoType.ts new file mode 100644 index 00000000..ace3d3c9 --- /dev/null +++ b/src/api/types/UpdateCodeToolDtoType.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The type of tool. "code" for Code tool. */ +export const UpdateCodeToolDtoType = { + Code: "code", +} as const; +export type UpdateCodeToolDtoType = (typeof UpdateCodeToolDtoType)[keyof typeof UpdateCodeToolDtoType]; diff --git a/src/api/types/UpdateComputerToolDto.ts b/src/api/types/UpdateComputerToolDto.ts index 3f116acb..03448885 100644 --- a/src/api/types/UpdateComputerToolDto.ts +++ b/src/api/types/UpdateComputerToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan. + */ export interface UpdateComputerToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateComputerToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType?: Vapi.UpdateComputerToolDtoSubType | undefined; diff --git a/src/api/types/UpdateCustomCredentialDto.ts b/src/api/types/UpdateCustomCredentialDto.ts index 4daaa1de..eb852f8d 100644 --- a/src/api/types/UpdateCustomCredentialDto.ts +++ b/src/api/types/UpdateCustomCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateCustomCredentialDto { + provider?: Vapi.UpdateCustomCredentialDtoProvider | undefined; /** This is the authentication plan. Supports OAuth2 RFC 6749, HMAC signing, and Bearer authentication. */ authenticationPlan?: Vapi.UpdateCustomCredentialDtoAuthenticationPlan | undefined; /** This is the encryption plan for encrypting sensitive data. Currently supports public-key encryption. */ diff --git a/src/api/types/UpdateCustomCredentialDtoProvider.ts b/src/api/types/UpdateCustomCredentialDtoProvider.ts new file mode 100644 index 00000000..7e508721 --- /dev/null +++ b/src/api/types/UpdateCustomCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateCustomCredentialDtoProvider = { + CustomCredential: "custom-credential", +} as const; +export type UpdateCustomCredentialDtoProvider = + (typeof UpdateCustomCredentialDtoProvider)[keyof typeof UpdateCustomCredentialDtoProvider]; diff --git a/src/api/types/UpdateCustomKnowledgeBaseDto.ts b/src/api/types/UpdateCustomKnowledgeBaseDto.ts index 91b5b5b7..72cd26e6 100644 --- a/src/api/types/UpdateCustomKnowledgeBaseDto.ts +++ b/src/api/types/UpdateCustomKnowledgeBaseDto.ts @@ -3,6 +3,8 @@ import type * as Vapi from "../index.js"; export interface UpdateCustomKnowledgeBaseDto { + /** This knowledge base is bring your own knowledge base implementation. */ + provider?: Vapi.UpdateCustomKnowledgeBaseDtoProvider | undefined; /** * This is where the knowledge base request will be sent. * diff --git a/src/api/types/UpdateCustomKnowledgeBaseDtoProvider.ts b/src/api/types/UpdateCustomKnowledgeBaseDtoProvider.ts new file mode 100644 index 00000000..277d3443 --- /dev/null +++ b/src/api/types/UpdateCustomKnowledgeBaseDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This knowledge base is bring your own knowledge base implementation. */ +export const UpdateCustomKnowledgeBaseDtoProvider = { + CustomKnowledgeBase: "custom-knowledge-base", +} as const; +export type UpdateCustomKnowledgeBaseDtoProvider = + (typeof UpdateCustomKnowledgeBaseDtoProvider)[keyof typeof UpdateCustomKnowledgeBaseDtoProvider]; diff --git a/src/api/types/UpdateCustomLlmCredentialDto.ts b/src/api/types/UpdateCustomLlmCredentialDto.ts index 00311343..95045672 100644 --- a/src/api/types/UpdateCustomLlmCredentialDto.ts +++ b/src/api/types/UpdateCustomLlmCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateCustomLlmCredentialDto { + provider?: Vapi.UpdateCustomLlmCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the authentication plan. Currently supports OAuth2 RFC 6749. To use Bearer authentication, use apiKey */ diff --git a/src/api/types/UpdateCustomLlmCredentialDtoProvider.ts b/src/api/types/UpdateCustomLlmCredentialDtoProvider.ts new file mode 100644 index 00000000..3f93a346 --- /dev/null +++ b/src/api/types/UpdateCustomLlmCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateCustomLlmCredentialDtoProvider = { + CustomLlm: "custom-llm", +} as const; +export type UpdateCustomLlmCredentialDtoProvider = + (typeof UpdateCustomLlmCredentialDtoProvider)[keyof typeof UpdateCustomLlmCredentialDtoProvider]; diff --git a/src/api/types/UpdateDeepInfraCredentialDto.ts b/src/api/types/UpdateDeepInfraCredentialDto.ts index c9283eb5..d23eddee 100644 --- a/src/api/types/UpdateDeepInfraCredentialDto.ts +++ b/src/api/types/UpdateDeepInfraCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateDeepInfraCredentialDto { + provider?: Vapi.UpdateDeepInfraCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateDeepInfraCredentialDtoProvider.ts b/src/api/types/UpdateDeepInfraCredentialDtoProvider.ts new file mode 100644 index 00000000..6d6166f0 --- /dev/null +++ b/src/api/types/UpdateDeepInfraCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateDeepInfraCredentialDtoProvider = { + Deepinfra: "deepinfra", +} as const; +export type UpdateDeepInfraCredentialDtoProvider = + (typeof UpdateDeepInfraCredentialDtoProvider)[keyof typeof UpdateDeepInfraCredentialDtoProvider]; diff --git a/src/api/types/UpdateDeepSeekCredentialDto.ts b/src/api/types/UpdateDeepSeekCredentialDto.ts index 9a34650f..5f742ae0 100644 --- a/src/api/types/UpdateDeepSeekCredentialDto.ts +++ b/src/api/types/UpdateDeepSeekCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateDeepSeekCredentialDto { + provider?: Vapi.UpdateDeepSeekCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateDeepSeekCredentialDtoProvider.ts b/src/api/types/UpdateDeepSeekCredentialDtoProvider.ts new file mode 100644 index 00000000..9fe5cd74 --- /dev/null +++ b/src/api/types/UpdateDeepSeekCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateDeepSeekCredentialDtoProvider = { + DeepSeek: "deep-seek", +} as const; +export type UpdateDeepSeekCredentialDtoProvider = + (typeof UpdateDeepSeekCredentialDtoProvider)[keyof typeof UpdateDeepSeekCredentialDtoProvider]; diff --git a/src/api/types/UpdateDeepgramCredentialDto.ts b/src/api/types/UpdateDeepgramCredentialDto.ts index 82f61bb0..095f61a3 100644 --- a/src/api/types/UpdateDeepgramCredentialDto.ts +++ b/src/api/types/UpdateDeepgramCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateDeepgramCredentialDto { + provider?: Vapi.UpdateDeepgramCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateDeepgramCredentialDtoProvider.ts b/src/api/types/UpdateDeepgramCredentialDtoProvider.ts new file mode 100644 index 00000000..fcd7acbc --- /dev/null +++ b/src/api/types/UpdateDeepgramCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateDeepgramCredentialDtoProvider = { + Deepgram: "deepgram", +} as const; +export type UpdateDeepgramCredentialDtoProvider = + (typeof UpdateDeepgramCredentialDtoProvider)[keyof typeof UpdateDeepgramCredentialDtoProvider]; diff --git a/src/api/types/UpdateDtmfToolDto.ts b/src/api/types/UpdateDtmfToolDto.ts index 6d5d0aa9..70981e24 100644 --- a/src/api/types/UpdateDtmfToolDto.ts +++ b/src/api/types/UpdateDtmfToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior. + */ export interface UpdateDtmfToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateDtmfToolDtoMessagesItem[] | undefined; /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833 (RTP events). When enabled, DTMF digits will be sent using the SIP INFO method, which can be more reliable in some network configurations. Only relevant when using the `vapi.sip` transport. */ sipInfoDtmfEnabled?: boolean | undefined; diff --git a/src/api/types/UpdateElevenLabsCredentialDto.ts b/src/api/types/UpdateElevenLabsCredentialDto.ts index 5a769fa3..b9862078 100644 --- a/src/api/types/UpdateElevenLabsCredentialDto.ts +++ b/src/api/types/UpdateElevenLabsCredentialDto.ts @@ -1,9 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateElevenLabsCredentialDto { + provider?: "11labs" | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; + /** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ + apiUrl?: (Vapi.UpdateElevenLabsCredentialDtoApiUrl | null) | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; - provider?: "11labs" | undefined; } diff --git a/src/api/types/UpdateElevenLabsCredentialDtoApiUrl.ts b/src/api/types/UpdateElevenLabsCredentialDtoApiUrl.ts new file mode 100644 index 00000000..aaef9705 --- /dev/null +++ b/src/api/types/UpdateElevenLabsCredentialDtoApiUrl.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** ElevenLabs-only API environment for this key: the global endpoint or the EU data residency endpoint. In EU deployments, new credentials must explicitly use the EU data residency endpoint; existing credentials may omit this field on update to retain their saved endpoint. Outside EU deployments, Vapi detects an omitted endpoint automatically and null on update clears and re-detects the endpoint. */ +export const UpdateElevenLabsCredentialDtoApiUrl = { + HttpsApiElevenlabsIo: "https://api.elevenlabs.io", + HttpsApiEuResidencyElevenlabsIo: "https://api.eu.residency.elevenlabs.io", +} as const; +export type UpdateElevenLabsCredentialDtoApiUrl = + (typeof UpdateElevenLabsCredentialDtoApiUrl)[keyof typeof UpdateElevenLabsCredentialDtoApiUrl]; diff --git a/src/api/types/UpdateEmailCredentialDto.ts b/src/api/types/UpdateEmailCredentialDto.ts index 2e0b2dd6..df68f775 100644 --- a/src/api/types/UpdateEmailCredentialDto.ts +++ b/src/api/types/UpdateEmailCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateEmailCredentialDto { + provider?: Vapi.UpdateEmailCredentialDtoProvider | undefined; /** The recipient email address for alerts */ email?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateEmailCredentialDtoProvider.ts b/src/api/types/UpdateEmailCredentialDtoProvider.ts new file mode 100644 index 00000000..92b4c979 --- /dev/null +++ b/src/api/types/UpdateEmailCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateEmailCredentialDtoProvider = { + Email: "email", +} as const; +export type UpdateEmailCredentialDtoProvider = + (typeof UpdateEmailCredentialDtoProvider)[keyof typeof UpdateEmailCredentialDtoProvider]; diff --git a/src/api/types/UpdateEndCallToolDto.ts b/src/api/types/UpdateEndCallToolDto.ts index fae27240..17eab69b 100644 --- a/src/api/types/UpdateEndCallToolDto.ts +++ b/src/api/types/UpdateEndCallToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an end-call tool, including its spoken messages and rejection plan. + */ export interface UpdateEndCallToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateEndCallToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateFunctionToolDto.ts b/src/api/types/UpdateFunctionToolDto.ts index a3fe5909..5a37dd10 100644 --- a/src/api/types/UpdateFunctionToolDto.ts +++ b/src/api/types/UpdateFunctionToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior. + */ export interface UpdateFunctionToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateFunctionToolDtoMessagesItem[] | undefined; /** * This determines if the tool is async. diff --git a/src/api/types/UpdateGcpCredentialDto.ts b/src/api/types/UpdateGcpCredentialDto.ts index 8525c77a..0bf8079b 100644 --- a/src/api/types/UpdateGcpCredentialDto.ts +++ b/src/api/types/UpdateGcpCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateGcpCredentialDto { + provider?: Vapi.UpdateGcpCredentialDtoProvider | undefined; /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ fallbackIndex?: number | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGcpCredentialDtoProvider.ts b/src/api/types/UpdateGcpCredentialDtoProvider.ts new file mode 100644 index 00000000..2519196f --- /dev/null +++ b/src/api/types/UpdateGcpCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGcpCredentialDtoProvider = { + Gcp: "gcp", +} as const; +export type UpdateGcpCredentialDtoProvider = + (typeof UpdateGcpCredentialDtoProvider)[keyof typeof UpdateGcpCredentialDtoProvider]; diff --git a/src/api/types/UpdateGhlToolDto.ts b/src/api/types/UpdateGhlToolDto.ts index b0ae9acc..6cc1d964 100644 --- a/src/api/types/UpdateGhlToolDto.ts +++ b/src/api/types/UpdateGhlToolDto.ts @@ -3,12 +3,10 @@ import type * as Vapi from "../index.js"; export interface UpdateGhlToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGhlToolDtoMessagesItem[] | undefined; + /** The type of tool. "ghl" for GHL tool. */ + type?: Vapi.UpdateGhlToolDtoType | undefined; /** * This is the plan to reject a tool call based on the conversation state. * diff --git a/src/api/types/UpdateGhlToolDtoType.ts b/src/api/types/UpdateGhlToolDtoType.ts new file mode 100644 index 00000000..57e5cb84 --- /dev/null +++ b/src/api/types/UpdateGhlToolDtoType.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The type of tool. "ghl" for GHL tool. */ +export const UpdateGhlToolDtoType = { + Ghl: "ghl", +} as const; +export type UpdateGhlToolDtoType = (typeof UpdateGhlToolDtoType)[keyof typeof UpdateGhlToolDtoType]; diff --git a/src/api/types/UpdateGladiaCredentialDto.ts b/src/api/types/UpdateGladiaCredentialDto.ts index d69b461a..6752daa3 100644 --- a/src/api/types/UpdateGladiaCredentialDto.ts +++ b/src/api/types/UpdateGladiaCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGladiaCredentialDto { + provider?: Vapi.UpdateGladiaCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGladiaCredentialDtoProvider.ts b/src/api/types/UpdateGladiaCredentialDtoProvider.ts new file mode 100644 index 00000000..99d79a9a --- /dev/null +++ b/src/api/types/UpdateGladiaCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGladiaCredentialDtoProvider = { + Gladia: "gladia", +} as const; +export type UpdateGladiaCredentialDtoProvider = + (typeof UpdateGladiaCredentialDtoProvider)[keyof typeof UpdateGladiaCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts b/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts index 5036ecf3..18ba05c1 100644 --- a/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts +++ b/src/api/types/UpdateGoHighLevelCalendarAvailabilityToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelCalendarAvailabilityToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoHighLevelCalendarAvailabilityToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts b/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts index f7a8120f..2baf5046 100644 --- a/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts +++ b/src/api/types/UpdateGoHighLevelCalendarEventCreateToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelCalendarEventCreateToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoHighLevelCalendarEventCreateToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts b/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts index 2321d337..a914b860 100644 --- a/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts +++ b/src/api/types/UpdateGoHighLevelContactCreateToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelContactCreateToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoHighLevelContactCreateToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoHighLevelContactGetToolDto.ts b/src/api/types/UpdateGoHighLevelContactGetToolDto.ts index 2e1acbf7..f3a848a2 100644 --- a/src/api/types/UpdateGoHighLevelContactGetToolDto.ts +++ b/src/api/types/UpdateGoHighLevelContactGetToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan. + */ export interface UpdateGoHighLevelContactGetToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoHighLevelContactGetToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoHighLevelCredentialDto.ts b/src/api/types/UpdateGoHighLevelCredentialDto.ts index 6a7df578..ccefa2ca 100644 --- a/src/api/types/UpdateGoHighLevelCredentialDto.ts +++ b/src/api/types/UpdateGoHighLevelCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGoHighLevelCredentialDto { + provider?: Vapi.UpdateGoHighLevelCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGoHighLevelCredentialDtoProvider.ts b/src/api/types/UpdateGoHighLevelCredentialDtoProvider.ts new file mode 100644 index 00000000..961fc4b8 --- /dev/null +++ b/src/api/types/UpdateGoHighLevelCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGoHighLevelCredentialDtoProvider = { + Gohighlevel: "gohighlevel", +} as const; +export type UpdateGoHighLevelCredentialDtoProvider = + (typeof UpdateGoHighLevelCredentialDtoProvider)[keyof typeof UpdateGoHighLevelCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoHighLevelMcpCredentialDto.ts b/src/api/types/UpdateGoHighLevelMcpCredentialDto.ts index ba3fe332..28f8f1e8 100644 --- a/src/api/types/UpdateGoHighLevelMcpCredentialDto.ts +++ b/src/api/types/UpdateGoHighLevelMcpCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateGoHighLevelMcpCredentialDto { + provider?: Vapi.UpdateGoHighLevelMcpCredentialDtoProvider | undefined; /** This is the authentication session for the credential. */ authenticationSession?: Vapi.Oauth2AuthenticationSession | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGoHighLevelMcpCredentialDtoProvider.ts b/src/api/types/UpdateGoHighLevelMcpCredentialDtoProvider.ts new file mode 100644 index 00000000..d605564b --- /dev/null +++ b/src/api/types/UpdateGoHighLevelMcpCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGoHighLevelMcpCredentialDtoProvider = { + GhlOauth2Authorization: "ghl.oauth2-authorization", +} as const; +export type UpdateGoHighLevelMcpCredentialDtoProvider = + (typeof UpdateGoHighLevelMcpCredentialDtoProvider)[keyof typeof UpdateGoHighLevelMcpCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts b/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts index a4b725eb..79ee280d 100644 --- a/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts +++ b/src/api/types/UpdateGoogleCalendarCheckAvailabilityToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleCalendarCheckAvailabilityToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoogleCalendarCheckAvailabilityToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts b/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts index a30f4c18..9563d6e9 100644 --- a/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts +++ b/src/api/types/UpdateGoogleCalendarCreateEventToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleCalendarCreateEventToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoogleCalendarCreateEventToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDto.ts b/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDto.ts index 1953385a..8bb96b65 100644 --- a/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGoogleCalendarOAuth2AuthorizationCredentialDto { + provider?: Vapi.UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider | undefined; /** The authorization ID for the OAuth2 authorization */ authorizationId?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider.ts b/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider.ts new file mode 100644 index 00000000..9371503a --- /dev/null +++ b/src/api/types/UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider = { + GoogleCalendarOauth2Authorization: "google.calendar.oauth2-authorization", +} as const; +export type UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider = + (typeof UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider)[keyof typeof UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDto.ts b/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDto.ts index 15721b08..60c887ac 100644 --- a/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDto.ts +++ b/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGoogleCalendarOAuth2ClientCredentialDto { + provider?: Vapi.UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider.ts b/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider.ts new file mode 100644 index 00000000..e1a9b659 --- /dev/null +++ b/src/api/types/UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider = { + GoogleCalendarOauth2Client: "google.calendar.oauth2-client", +} as const; +export type UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider = + (typeof UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider)[keyof typeof UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoogleCredentialDto.ts b/src/api/types/UpdateGoogleCredentialDto.ts index bc6736fb..c82ffb7c 100644 --- a/src/api/types/UpdateGoogleCredentialDto.ts +++ b/src/api/types/UpdateGoogleCredentialDto.ts @@ -1,6 +1,10 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGoogleCredentialDto { + /** This is the key for Gemini in Google AI Studio. Get it from here: https://aistudio.google.com/app/apikey */ + provider?: Vapi.UpdateGoogleCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGoogleCredentialDtoProvider.ts b/src/api/types/UpdateGoogleCredentialDtoProvider.ts new file mode 100644 index 00000000..98272a06 --- /dev/null +++ b/src/api/types/UpdateGoogleCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the key for Gemini in Google AI Studio. Get it from here: https://aistudio.google.com/app/apikey */ +export const UpdateGoogleCredentialDtoProvider = { + Google: "google", +} as const; +export type UpdateGoogleCredentialDtoProvider = + (typeof UpdateGoogleCredentialDtoProvider)[keyof typeof UpdateGoogleCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDto.ts b/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDto.ts index 634f5423..51ac822d 100644 --- a/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGoogleSheetsOAuth2AuthorizationCredentialDto { + provider?: Vapi.UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider | undefined; /** The authorization ID for the OAuth2 authorization */ authorizationId?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider.ts b/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider.ts new file mode 100644 index 00000000..4c6253c3 --- /dev/null +++ b/src/api/types/UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider = { + GoogleSheetsOauth2Authorization: "google.sheets.oauth2-authorization", +} as const; +export type UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider = + (typeof UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider)[keyof typeof UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider]; diff --git a/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts b/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts index 634f674f..88f3d454 100644 --- a/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts +++ b/src/api/types/UpdateGoogleSheetsRowAppendToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan. + */ export interface UpdateGoogleSheetsRowAppendToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateGoogleSheetsRowAppendToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateGroqCredentialDto.ts b/src/api/types/UpdateGroqCredentialDto.ts index 2019375e..10b23850 100644 --- a/src/api/types/UpdateGroqCredentialDto.ts +++ b/src/api/types/UpdateGroqCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateGroqCredentialDto { + provider?: Vapi.UpdateGroqCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateGroqCredentialDtoProvider.ts b/src/api/types/UpdateGroqCredentialDtoProvider.ts new file mode 100644 index 00000000..6e56399c --- /dev/null +++ b/src/api/types/UpdateGroqCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateGroqCredentialDtoProvider = { + Groq: "groq", +} as const; +export type UpdateGroqCredentialDtoProvider = + (typeof UpdateGroqCredentialDtoProvider)[keyof typeof UpdateGroqCredentialDtoProvider]; diff --git a/src/api/types/UpdateHandoffToolDto.ts b/src/api/types/UpdateHandoffToolDto.ts index 4a114c6e..ec87445b 100644 --- a/src/api/types/UpdateHandoffToolDto.ts +++ b/src/api/types/UpdateHandoffToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan. + */ export interface UpdateHandoffToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateHandoffToolDtoMessagesItem[] | undefined; /** This is the default local tool result message used when no runtime handoff result override is returned. */ defaultResult?: string | undefined; diff --git a/src/api/types/UpdateHandoffToolDtoDestinationsItem.ts b/src/api/types/UpdateHandoffToolDtoDestinationsItem.ts index e010dfa7..7f3505db 100644 --- a/src/api/types/UpdateHandoffToolDtoDestinationsItem.ts +++ b/src/api/types/UpdateHandoffToolDtoDestinationsItem.ts @@ -19,4 +19,9 @@ export namespace UpdateHandoffToolDtoDestinationsItem { export interface Squad extends Vapi.HandoffDestinationSquad { type: "squad"; } + + export type Response = + | Vapi.UpdateHandoffToolDtoDestinationsItem.Assistant + | Vapi.UpdateHandoffToolDtoDestinationsItem.Dynamic + | Vapi.UpdateHandoffToolDtoDestinationsItem.Squad; } diff --git a/src/api/types/UpdateHumeCredentialDto.ts b/src/api/types/UpdateHumeCredentialDto.ts index 6af3d065..73b6a1b0 100644 --- a/src/api/types/UpdateHumeCredentialDto.ts +++ b/src/api/types/UpdateHumeCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateHumeCredentialDto { + provider?: Vapi.UpdateHumeCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateHumeCredentialDtoProvider.ts b/src/api/types/UpdateHumeCredentialDtoProvider.ts new file mode 100644 index 00000000..5fe0341f --- /dev/null +++ b/src/api/types/UpdateHumeCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateHumeCredentialDtoProvider = { + Hume: "hume", +} as const; +export type UpdateHumeCredentialDtoProvider = + (typeof UpdateHumeCredentialDtoProvider)[keyof typeof UpdateHumeCredentialDtoProvider]; diff --git a/src/api/types/UpdateInflectionAiCredentialDto.ts b/src/api/types/UpdateInflectionAiCredentialDto.ts index 37a7c203..46aefccf 100644 --- a/src/api/types/UpdateInflectionAiCredentialDto.ts +++ b/src/api/types/UpdateInflectionAiCredentialDto.ts @@ -1,6 +1,10 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateInflectionAiCredentialDto { + /** This is the api key for Pi in InflectionAI's console. Get it from here: https://developers.inflection.ai/keys, billing will need to be setup */ + provider?: Vapi.UpdateInflectionAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateInflectionAiCredentialDtoProvider.ts b/src/api/types/UpdateInflectionAiCredentialDtoProvider.ts new file mode 100644 index 00000000..03c97763 --- /dev/null +++ b/src/api/types/UpdateInflectionAiCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the api key for Pi in InflectionAI's console. Get it from here: https://developers.inflection.ai/keys, billing will need to be setup */ +export const UpdateInflectionAiCredentialDtoProvider = { + InflectionAi: "inflection-ai", +} as const; +export type UpdateInflectionAiCredentialDtoProvider = + (typeof UpdateInflectionAiCredentialDtoProvider)[keyof typeof UpdateInflectionAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateInworldCredentialDto.ts b/src/api/types/UpdateInworldCredentialDto.ts index 2e0ef25e..6b8718b7 100644 --- a/src/api/types/UpdateInworldCredentialDto.ts +++ b/src/api/types/UpdateInworldCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateInworldCredentialDto { + provider?: Vapi.UpdateInworldCredentialDtoProvider | undefined; /** This is the Inworld Basic (Base64) authentication token. This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateInworldCredentialDtoProvider.ts b/src/api/types/UpdateInworldCredentialDtoProvider.ts new file mode 100644 index 00000000..3e29688a --- /dev/null +++ b/src/api/types/UpdateInworldCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateInworldCredentialDtoProvider = { + Inworld: "inworld", +} as const; +export type UpdateInworldCredentialDtoProvider = + (typeof UpdateInworldCredentialDtoProvider)[keyof typeof UpdateInworldCredentialDtoProvider]; diff --git a/src/api/types/UpdateKnowledgeBaseToolDto.ts b/src/api/types/UpdateKnowledgeBaseToolDto.ts new file mode 100644 index 00000000..6b795278 --- /dev/null +++ b/src/api/types/UpdateKnowledgeBaseToolDto.ts @@ -0,0 +1,92 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface UpdateKnowledgeBaseToolDto { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.UpdateKnowledgeBaseToolDtoMessagesItem[] | undefined; + /** The knowledge base this tool searches. At most one search tool references a knowledge base. Deleting the base also deletes its generated tool; null references are retained only for backward compatibility and are inert. */ + knowledgeBaseId?: (string | null) | undefined; + function?: Vapi.KnowledgeBaseToolFunction | undefined; + /** + * This is the plan to reject a tool call based on the conversation state. + * + * // Example 1: Reject endCall if user didn't say goodbye + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', + * target: { position: -1, role: 'user' }, + * negate: true // Reject if pattern does NOT match + * }] + * } + * ``` + * + * // Example 2: Reject transfer if user is actually asking a question + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '\\?', + * target: { position: -1, role: 'user' } + * }] + * } + * ``` + * + * // Example 3: Reject transfer if user didn't mention transfer recently + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 5 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' %} + * {% assign mentioned = false %} + * {% for msg in userMessages %} + * {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} + * {% assign mentioned = true %} + * {% break %} + * {% endif %} + * {% endfor %} + * {% if mentioned %} + * false + * {% else %} + * true + * {% endif %}` + * }] + * } + * ``` + * + * // Example 4: Reject endCall if the bot is looping and trying to exit + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 6 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} + * {% if userMessages.size < 3 %} + * false + * {% else %} + * {% assign msg1 = userMessages[0].content | downcase %} + * {% assign msg2 = userMessages[1].content | downcase %} + * {% assign msg3 = userMessages[2].content | downcase %} + * {% comment %} Check for repetitive messages {% endcomment %} + * {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} + * true + * {% comment %} Check for common loop phrases {% endcomment %} + * {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} + * true + * {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} + * true + * {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} + * true + * {% else %} + * false + * {% endif %} + * {% endif %}` + * }] + * } + * ``` + */ + rejectionPlan?: Vapi.ToolRejectionPlan | undefined; +} diff --git a/src/api/types/UpdateKnowledgeBaseToolDtoMessagesItem.ts b/src/api/types/UpdateKnowledgeBaseToolDtoMessagesItem.ts new file mode 100644 index 00000000..675d1a93 --- /dev/null +++ b/src/api/types/UpdateKnowledgeBaseToolDtoMessagesItem.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type UpdateKnowledgeBaseToolDtoMessagesItem = + | Vapi.UpdateKnowledgeBaseToolDtoMessagesItem.RequestStart + | Vapi.UpdateKnowledgeBaseToolDtoMessagesItem.RequestComplete + | Vapi.UpdateKnowledgeBaseToolDtoMessagesItem.RequestFailed + | Vapi.UpdateKnowledgeBaseToolDtoMessagesItem.RequestResponseDelayed; + +export namespace UpdateKnowledgeBaseToolDtoMessagesItem { + export interface RequestStart extends Vapi.ToolMessageStart { + type: "request-start"; + } + + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } + + export interface RequestResponseDelayed extends Vapi.ToolMessageDelayed { + type: "request-response-delayed"; + } +} diff --git a/src/api/types/UpdateLangfuseCredentialDto.ts b/src/api/types/UpdateLangfuseCredentialDto.ts index 42105692..34dffd94 100644 --- a/src/api/types/UpdateLangfuseCredentialDto.ts +++ b/src/api/types/UpdateLangfuseCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateLangfuseCredentialDto { + provider?: Vapi.UpdateLangfuseCredentialDtoProvider | undefined; /** The public key for Langfuse project. Eg: pk-lf-... */ publicKey?: string | undefined; /** The secret key for Langfuse project. Eg: sk-lf-... .This is not returned in the API. */ diff --git a/src/api/types/UpdateLangfuseCredentialDtoProvider.ts b/src/api/types/UpdateLangfuseCredentialDtoProvider.ts new file mode 100644 index 00000000..7ffa7aef --- /dev/null +++ b/src/api/types/UpdateLangfuseCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateLangfuseCredentialDtoProvider = { + Langfuse: "langfuse", +} as const; +export type UpdateLangfuseCredentialDtoProvider = + (typeof UpdateLangfuseCredentialDtoProvider)[keyof typeof UpdateLangfuseCredentialDtoProvider]; diff --git a/src/api/types/UpdateLineInsightFromCallTableDto.ts b/src/api/types/UpdateLineInsightFromCallTableDto.ts index 88ec4d5b..4689a71c 100644 --- a/src/api/types/UpdateLineInsightFromCallTableDto.ts +++ b/src/api/types/UpdateLineInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ export interface UpdateLineInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -25,6 +28,7 @@ export interface UpdateLineInsightFromCallTableDto { formulas?: Vapi.InsightFormula[] | undefined; /** This is the metadata for the insight. */ metadata?: Vapi.LineInsightMetadata | undefined; + /** The time range and interval used to aggregate the line-chart data. */ timeRange?: Vapi.InsightTimeRangeWithStep | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdateLmntCredentialDto.ts b/src/api/types/UpdateLmntCredentialDto.ts index 349fc373..5d629ca0 100644 --- a/src/api/types/UpdateLmntCredentialDto.ts +++ b/src/api/types/UpdateLmntCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateLmntCredentialDto { + provider?: Vapi.UpdateLmntCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateLmntCredentialDtoProvider.ts b/src/api/types/UpdateLmntCredentialDtoProvider.ts new file mode 100644 index 00000000..fc1d886c --- /dev/null +++ b/src/api/types/UpdateLmntCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateLmntCredentialDtoProvider = { + Lmnt: "lmnt", +} as const; +export type UpdateLmntCredentialDtoProvider = + (typeof UpdateLmntCredentialDtoProvider)[keyof typeof UpdateLmntCredentialDtoProvider]; diff --git a/src/api/types/UpdateMakeCredentialDto.ts b/src/api/types/UpdateMakeCredentialDto.ts index 950cfa0e..0984b507 100644 --- a/src/api/types/UpdateMakeCredentialDto.ts +++ b/src/api/types/UpdateMakeCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateMakeCredentialDto { + provider?: Vapi.UpdateMakeCredentialDtoProvider | undefined; /** Team ID */ teamId?: string | undefined; /** Region of your application. For example: eu1, eu2, us1, us2 */ diff --git a/src/api/types/UpdateMakeCredentialDtoProvider.ts b/src/api/types/UpdateMakeCredentialDtoProvider.ts new file mode 100644 index 00000000..07588dd9 --- /dev/null +++ b/src/api/types/UpdateMakeCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateMakeCredentialDtoProvider = { + Make: "make", +} as const; +export type UpdateMakeCredentialDtoProvider = + (typeof UpdateMakeCredentialDtoProvider)[keyof typeof UpdateMakeCredentialDtoProvider]; diff --git a/src/api/types/UpdateMakeToolDto.ts b/src/api/types/UpdateMakeToolDto.ts index 1540988e..7772f382 100644 --- a/src/api/types/UpdateMakeToolDto.ts +++ b/src/api/types/UpdateMakeToolDto.ts @@ -3,12 +3,10 @@ import type * as Vapi from "../index.js"; export interface UpdateMakeToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateMakeToolDtoMessagesItem[] | undefined; + /** The type of tool. "make" for Make tool. */ + type?: Vapi.UpdateMakeToolDtoType | undefined; /** * This is the plan to reject a tool call based on the conversation state. * diff --git a/src/api/types/UpdateMakeToolDtoType.ts b/src/api/types/UpdateMakeToolDtoType.ts new file mode 100644 index 00000000..d2e0a644 --- /dev/null +++ b/src/api/types/UpdateMakeToolDtoType.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The type of tool. "make" for Make tool. */ +export const UpdateMakeToolDtoType = { + Make: "make", +} as const; +export type UpdateMakeToolDtoType = (typeof UpdateMakeToolDtoType)[keyof typeof UpdateMakeToolDtoType]; diff --git a/src/api/types/UpdateMcpToolDto.ts b/src/api/types/UpdateMcpToolDto.ts index 8f8d05fa..fe7034f4 100644 --- a/src/api/types/UpdateMcpToolDto.ts +++ b/src/api/types/UpdateMcpToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan. + */ export interface UpdateMcpToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateMcpToolDtoMessagesItem[] | undefined; /** * This is the server where a `tool-calls` webhook will be sent. @@ -103,5 +102,6 @@ export interface UpdateMcpToolDto { * ``` */ rejectionPlan?: Vapi.ToolRejectionPlan | undefined; + /** Connection metadata for the MCP server, including its communication protocol. */ metadata?: Vapi.McpToolMetadata | undefined; } diff --git a/src/api/types/UpdateMicrosoftCredentialDto.ts b/src/api/types/UpdateMicrosoftCredentialDto.ts new file mode 100644 index 00000000..5b8edb5b --- /dev/null +++ b/src/api/types/UpdateMicrosoftCredentialDto.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface UpdateMicrosoftCredentialDto { + provider?: Vapi.UpdateMicrosoftCredentialDtoProvider | undefined; + /** This is not returned in the API. */ + apiKey?: string | undefined; + /** Azure region for the Speech resource. Defaults to `eastus` when omitted. MAI-Voice-2 is preview and region-limited. */ + region?: string | undefined; + /** This is the name of credential. This is just for your reference. */ + name?: string | undefined; +} diff --git a/src/api/types/UpdateMicrosoftCredentialDtoProvider.ts b/src/api/types/UpdateMicrosoftCredentialDtoProvider.ts new file mode 100644 index 00000000..ea897307 --- /dev/null +++ b/src/api/types/UpdateMicrosoftCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateMicrosoftCredentialDtoProvider = { + Microsoft: "microsoft", +} as const; +export type UpdateMicrosoftCredentialDtoProvider = + (typeof UpdateMicrosoftCredentialDtoProvider)[keyof typeof UpdateMicrosoftCredentialDtoProvider]; diff --git a/src/api/types/UpdateMistralCredentialDto.ts b/src/api/types/UpdateMistralCredentialDto.ts index 5d1745c0..bcdf34b4 100644 --- a/src/api/types/UpdateMistralCredentialDto.ts +++ b/src/api/types/UpdateMistralCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateMistralCredentialDto { + provider?: Vapi.UpdateMistralCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateMistralCredentialDtoProvider.ts b/src/api/types/UpdateMistralCredentialDtoProvider.ts new file mode 100644 index 00000000..221c4b99 --- /dev/null +++ b/src/api/types/UpdateMistralCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateMistralCredentialDtoProvider = { + Mistral: "mistral", +} as const; +export type UpdateMistralCredentialDtoProvider = + (typeof UpdateMistralCredentialDtoProvider)[keyof typeof UpdateMistralCredentialDtoProvider]; diff --git a/src/api/types/UpdateNeuphonicCredentialDto.ts b/src/api/types/UpdateNeuphonicCredentialDto.ts index c4bae3ae..ad7860c4 100644 --- a/src/api/types/UpdateNeuphonicCredentialDto.ts +++ b/src/api/types/UpdateNeuphonicCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateNeuphonicCredentialDto { + provider?: Vapi.UpdateNeuphonicCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateNeuphonicCredentialDtoProvider.ts b/src/api/types/UpdateNeuphonicCredentialDtoProvider.ts new file mode 100644 index 00000000..1fc20456 --- /dev/null +++ b/src/api/types/UpdateNeuphonicCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateNeuphonicCredentialDtoProvider = { + Neuphonic: "neuphonic", +} as const; +export type UpdateNeuphonicCredentialDtoProvider = + (typeof UpdateNeuphonicCredentialDtoProvider)[keyof typeof UpdateNeuphonicCredentialDtoProvider]; diff --git a/src/api/types/UpdateOpenAiCredentialDto.ts b/src/api/types/UpdateOpenAiCredentialDto.ts index eb593b62..47ca8a40 100644 --- a/src/api/types/UpdateOpenAiCredentialDto.ts +++ b/src/api/types/UpdateOpenAiCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateOpenAiCredentialDto { + provider?: Vapi.UpdateOpenAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateOpenAiCredentialDtoProvider.ts b/src/api/types/UpdateOpenAiCredentialDtoProvider.ts new file mode 100644 index 00000000..d879619d --- /dev/null +++ b/src/api/types/UpdateOpenAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateOpenAiCredentialDtoProvider = { + Openai: "openai", +} as const; +export type UpdateOpenAiCredentialDtoProvider = + (typeof UpdateOpenAiCredentialDtoProvider)[keyof typeof UpdateOpenAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateOpenRouterCredentialDto.ts b/src/api/types/UpdateOpenRouterCredentialDto.ts index c9def8c7..d684bf71 100644 --- a/src/api/types/UpdateOpenRouterCredentialDto.ts +++ b/src/api/types/UpdateOpenRouterCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateOpenRouterCredentialDto { + provider?: Vapi.UpdateOpenRouterCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateOpenRouterCredentialDtoProvider.ts b/src/api/types/UpdateOpenRouterCredentialDtoProvider.ts new file mode 100644 index 00000000..13e9908f --- /dev/null +++ b/src/api/types/UpdateOpenRouterCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateOpenRouterCredentialDtoProvider = { + Openrouter: "openrouter", +} as const; +export type UpdateOpenRouterCredentialDtoProvider = + (typeof UpdateOpenRouterCredentialDtoProvider)[keyof typeof UpdateOpenRouterCredentialDtoProvider]; diff --git a/src/api/types/UpdateOutputToolDto.ts b/src/api/types/UpdateOutputToolDto.ts index dc44253c..4d476884 100644 --- a/src/api/types/UpdateOutputToolDto.ts +++ b/src/api/types/UpdateOutputToolDto.ts @@ -3,12 +3,10 @@ import type * as Vapi from "../index.js"; export interface UpdateOutputToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateOutputToolDtoMessagesItem[] | undefined; + /** The type of tool. "output" for Output tool. */ + type?: Vapi.UpdateOutputToolDtoType | undefined; /** * This is the plan to reject a tool call based on the conversation state. * diff --git a/src/api/types/UpdateOutputToolDtoType.ts b/src/api/types/UpdateOutputToolDtoType.ts new file mode 100644 index 00000000..4c686a6b --- /dev/null +++ b/src/api/types/UpdateOutputToolDtoType.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The type of tool. "output" for Output tool. */ +export const UpdateOutputToolDtoType = { + Output: "output", +} as const; +export type UpdateOutputToolDtoType = (typeof UpdateOutputToolDtoType)[keyof typeof UpdateOutputToolDtoType]; diff --git a/src/api/types/UpdatePerplexityAiCredentialDto.ts b/src/api/types/UpdatePerplexityAiCredentialDto.ts index d91ef1e9..00daf20b 100644 --- a/src/api/types/UpdatePerplexityAiCredentialDto.ts +++ b/src/api/types/UpdatePerplexityAiCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdatePerplexityAiCredentialDto { + provider?: Vapi.UpdatePerplexityAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdatePerplexityAiCredentialDtoProvider.ts b/src/api/types/UpdatePerplexityAiCredentialDtoProvider.ts new file mode 100644 index 00000000..8dc6f3c6 --- /dev/null +++ b/src/api/types/UpdatePerplexityAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdatePerplexityAiCredentialDtoProvider = { + PerplexityAi: "perplexity-ai", +} as const; +export type UpdatePerplexityAiCredentialDtoProvider = + (typeof UpdatePerplexityAiCredentialDtoProvider)[keyof typeof UpdatePerplexityAiCredentialDtoProvider]; diff --git a/src/api/types/UpdatePieInsightFromCallTableDto.ts b/src/api/types/UpdatePieInsightFromCallTableDto.ts index b34cacb0..eac95df4 100644 --- a/src/api/types/UpdatePieInsightFromCallTableDto.ts +++ b/src/api/types/UpdatePieInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name. + */ export interface UpdatePieInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface UpdatePieInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formulas?: Vapi.InsightFormula[] | undefined; + /** The time range used to query the pie-chart data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * This is the group by column for the insight when table is `call`. diff --git a/src/api/types/UpdatePlayHtCredentialDto.ts b/src/api/types/UpdatePlayHtCredentialDto.ts index 9b9bd578..0f022ad5 100644 --- a/src/api/types/UpdatePlayHtCredentialDto.ts +++ b/src/api/types/UpdatePlayHtCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdatePlayHtCredentialDto { + provider?: Vapi.UpdatePlayHtCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdatePlayHtCredentialDtoProvider.ts b/src/api/types/UpdatePlayHtCredentialDtoProvider.ts new file mode 100644 index 00000000..d86e7bd3 --- /dev/null +++ b/src/api/types/UpdatePlayHtCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdatePlayHtCredentialDtoProvider = { + Playht: "playht", +} as const; +export type UpdatePlayHtCredentialDtoProvider = + (typeof UpdatePlayHtCredentialDtoProvider)[keyof typeof UpdatePlayHtCredentialDtoProvider]; diff --git a/src/api/types/UpdateQueryToolDto.ts b/src/api/types/UpdateQueryToolDto.ts index 09f56462..1778cd9e 100644 --- a/src/api/types/UpdateQueryToolDto.ts +++ b/src/api/types/UpdateQueryToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan. + */ export interface UpdateQueryToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateQueryToolDtoMessagesItem[] | undefined; /** The knowledge bases to query */ knowledgeBases?: Vapi.KnowledgeBase[] | undefined; diff --git a/src/api/types/UpdateRimeAiCredentialDto.ts b/src/api/types/UpdateRimeAiCredentialDto.ts index 4a9106b2..e8f7acb1 100644 --- a/src/api/types/UpdateRimeAiCredentialDto.ts +++ b/src/api/types/UpdateRimeAiCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateRimeAiCredentialDto { + provider?: Vapi.UpdateRimeAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateRimeAiCredentialDtoProvider.ts b/src/api/types/UpdateRimeAiCredentialDtoProvider.ts new file mode 100644 index 00000000..82827bff --- /dev/null +++ b/src/api/types/UpdateRimeAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateRimeAiCredentialDtoProvider = { + RimeAi: "rime-ai", +} as const; +export type UpdateRimeAiCredentialDtoProvider = + (typeof UpdateRimeAiCredentialDtoProvider)[keyof typeof UpdateRimeAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateRunpodCredentialDto.ts b/src/api/types/UpdateRunpodCredentialDto.ts index 4c15d55f..dcc0d9a7 100644 --- a/src/api/types/UpdateRunpodCredentialDto.ts +++ b/src/api/types/UpdateRunpodCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateRunpodCredentialDto { + provider?: Vapi.UpdateRunpodCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateRunpodCredentialDtoProvider.ts b/src/api/types/UpdateRunpodCredentialDtoProvider.ts new file mode 100644 index 00000000..87797fcc --- /dev/null +++ b/src/api/types/UpdateRunpodCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateRunpodCredentialDtoProvider = { + Runpod: "runpod", +} as const; +export type UpdateRunpodCredentialDtoProvider = + (typeof UpdateRunpodCredentialDtoProvider)[keyof typeof UpdateRunpodCredentialDtoProvider]; diff --git a/src/api/types/UpdateS3CompatibleBucketPlanDto.ts b/src/api/types/UpdateS3CompatibleBucketPlanDto.ts new file mode 100644 index 00000000..9b27aeef --- /dev/null +++ b/src/api/types/UpdateS3CompatibleBucketPlanDto.ts @@ -0,0 +1,16 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface UpdateS3CompatibleBucketPlanDto { + /** S3-compatible endpoint URL, such as https://s3.us-west-004.backblazeb2.com. Must be public HTTPS. */ + url?: string | undefined; + /** SigV4 signing region expected by the object store. Most stores accept us-east-1. */ + region?: string | undefined; + /** S3 access key ID. */ + accessKeyId?: string | undefined; + /** S3 secret access key. This is not returned in the API. */ + secretAccessKey?: string | undefined; + /** Bucket name. */ + name?: string | undefined; + /** Optional key prefix inside the bucket, such as recordings/. */ + path?: string | undefined; +} diff --git a/src/api/types/UpdateS3CompatibleCredentialDto.ts b/src/api/types/UpdateS3CompatibleCredentialDto.ts new file mode 100644 index 00000000..48b46de2 --- /dev/null +++ b/src/api/types/UpdateS3CompatibleCredentialDto.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface UpdateS3CompatibleCredentialDto { + /** This is for S3-compatible storage such as MinIO, Garage, Ceph, or Backblaze B2. */ + provider?: Vapi.UpdateS3CompatibleCredentialDtoProvider | undefined; + /** This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order. */ + fallbackIndex?: number | undefined; + bucketPlan?: Vapi.UpdateS3CompatibleBucketPlanDto | undefined; + /** This is the name of credential. This is just for your reference. */ + name?: string | undefined; +} diff --git a/src/api/types/UpdateS3CompatibleCredentialDtoProvider.ts b/src/api/types/UpdateS3CompatibleCredentialDtoProvider.ts new file mode 100644 index 00000000..98b83670 --- /dev/null +++ b/src/api/types/UpdateS3CompatibleCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is for S3-compatible storage such as MinIO, Garage, Ceph, or Backblaze B2. */ +export const UpdateS3CompatibleCredentialDtoProvider = { + S3Compatible: "s3-compatible", +} as const; +export type UpdateS3CompatibleCredentialDtoProvider = + (typeof UpdateS3CompatibleCredentialDtoProvider)[keyof typeof UpdateS3CompatibleCredentialDtoProvider]; diff --git a/src/api/types/UpdateS3CredentialDto.ts b/src/api/types/UpdateS3CredentialDto.ts index 2cbbac9e..bd6024c6 100644 --- a/src/api/types/UpdateS3CredentialDto.ts +++ b/src/api/types/UpdateS3CredentialDto.ts @@ -1,6 +1,10 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateS3CredentialDto { + /** Credential provider. Only allowed value is s3 */ + provider?: Vapi.UpdateS3CredentialDtoProvider | undefined; /** AWS access key ID. */ awsAccessKeyId?: string | undefined; /** AWS access key secret. This is not returned in the API. */ diff --git a/src/api/types/UpdateS3CredentialDtoProvider.ts b/src/api/types/UpdateS3CredentialDtoProvider.ts new file mode 100644 index 00000000..0048bfae --- /dev/null +++ b/src/api/types/UpdateS3CredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Credential provider. Only allowed value is s3 */ +export const UpdateS3CredentialDtoProvider = { + S3: "s3", +} as const; +export type UpdateS3CredentialDtoProvider = + (typeof UpdateS3CredentialDtoProvider)[keyof typeof UpdateS3CredentialDtoProvider]; diff --git a/src/api/types/UpdateSipRequestToolDto.ts b/src/api/types/UpdateSipRequestToolDto.ts index f62db805..5831f71d 100644 --- a/src/api/types/UpdateSipRequestToolDto.ts +++ b/src/api/types/UpdateSipRequestToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan. + */ export interface UpdateSipRequestToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateSipRequestToolDtoMessagesItem[] | undefined; /** The SIP method to send. */ verb?: Vapi.UpdateSipRequestToolDtoVerb | undefined; diff --git a/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDto.ts b/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDto.ts index 6ddf118c..7c60ff3f 100644 --- a/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDto.ts +++ b/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateSlackOAuth2AuthorizationCredentialDto { + provider?: Vapi.UpdateSlackOAuth2AuthorizationCredentialDtoProvider | undefined; /** The authorization ID for the OAuth2 authorization */ authorizationId?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDtoProvider.ts b/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDtoProvider.ts new file mode 100644 index 00000000..f778d812 --- /dev/null +++ b/src/api/types/UpdateSlackOAuth2AuthorizationCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateSlackOAuth2AuthorizationCredentialDtoProvider = { + SlackOauth2Authorization: "slack.oauth2-authorization", +} as const; +export type UpdateSlackOAuth2AuthorizationCredentialDtoProvider = + (typeof UpdateSlackOAuth2AuthorizationCredentialDtoProvider)[keyof typeof UpdateSlackOAuth2AuthorizationCredentialDtoProvider]; diff --git a/src/api/types/UpdateSlackSendMessageToolDto.ts b/src/api/types/UpdateSlackSendMessageToolDto.ts index e5d9fda2..5109ab09 100644 --- a/src/api/types/UpdateSlackSendMessageToolDto.ts +++ b/src/api/types/UpdateSlackSendMessageToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Slack message tool, including its spoken messages and rejection plan. + */ export interface UpdateSlackSendMessageToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateSlackSendMessageToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateSlackWebhookCredentialDto.ts b/src/api/types/UpdateSlackWebhookCredentialDto.ts index 0f528e69..39673f43 100644 --- a/src/api/types/UpdateSlackWebhookCredentialDto.ts +++ b/src/api/types/UpdateSlackWebhookCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateSlackWebhookCredentialDto { + provider?: Vapi.UpdateSlackWebhookCredentialDtoProvider | undefined; /** Slack incoming webhook URL. See https://api.slack.com/messaging/webhooks for setup instructions. This is not returned in the API. */ webhookUrl?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateSlackWebhookCredentialDtoProvider.ts b/src/api/types/UpdateSlackWebhookCredentialDtoProvider.ts new file mode 100644 index 00000000..3fbaa0f2 --- /dev/null +++ b/src/api/types/UpdateSlackWebhookCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateSlackWebhookCredentialDtoProvider = { + SlackWebhook: "slack-webhook", +} as const; +export type UpdateSlackWebhookCredentialDtoProvider = + (typeof UpdateSlackWebhookCredentialDtoProvider)[keyof typeof UpdateSlackWebhookCredentialDtoProvider]; diff --git a/src/api/types/UpdateSmsToolDto.ts b/src/api/types/UpdateSmsToolDto.ts index 5f1db8d9..0d590254 100644 --- a/src/api/types/UpdateSmsToolDto.ts +++ b/src/api/types/UpdateSmsToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update an SMS tool, including its spoken messages and rejection plan. + */ export interface UpdateSmsToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateSmsToolDtoMessagesItem[] | undefined; /** * This is the plan to reject a tool call based on the conversation state. diff --git a/src/api/types/UpdateSonioxCredentialDto.ts b/src/api/types/UpdateSonioxCredentialDto.ts index af426b84..31fbfeaa 100644 --- a/src/api/types/UpdateSonioxCredentialDto.ts +++ b/src/api/types/UpdateSonioxCredentialDto.ts @@ -1,8 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateSonioxCredentialDto { + provider?: Vapi.UpdateSonioxCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; + /** Custom Soniox WebSocket endpoint (e.g. EU server wss://stt-rt.eu.soniox.com/transcribe-websocket). Defaults to the region-appropriate endpoint when omitted. */ + apiUrl?: string | undefined; /** This is the name of credential. This is just for your reference. */ name?: string | undefined; } diff --git a/src/api/types/UpdateSonioxCredentialDtoProvider.ts b/src/api/types/UpdateSonioxCredentialDtoProvider.ts new file mode 100644 index 00000000..187530d4 --- /dev/null +++ b/src/api/types/UpdateSonioxCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateSonioxCredentialDtoProvider = { + Soniox: "soniox", +} as const; +export type UpdateSonioxCredentialDtoProvider = + (typeof UpdateSonioxCredentialDtoProvider)[keyof typeof UpdateSonioxCredentialDtoProvider]; diff --git a/src/api/types/UpdateTelnyxPhoneNumberDto.ts b/src/api/types/UpdateTelnyxPhoneNumberDto.ts index a15de859..4d01888d 100644 --- a/src/api/types/UpdateTelnyxPhoneNumberDto.ts +++ b/src/api/types/UpdateTelnyxPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateTelnyxPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateTextEditorToolDto.ts b/src/api/types/UpdateTextEditorToolDto.ts index ab8b1036..637f3208 100644 --- a/src/api/types/UpdateTextEditorToolDto.ts +++ b/src/api/types/UpdateTextEditorToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan. + */ export interface UpdateTextEditorToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateTextEditorToolDtoMessagesItem[] | undefined; /** The sub type of tool. */ subType?: Vapi.UpdateTextEditorToolDtoSubType | undefined; diff --git a/src/api/types/UpdateTextInsightFromCallTableDto.ts b/src/api/types/UpdateTextInsightFromCallTableDto.ts index 57f45b7c..a8b97d99 100644 --- a/src/api/types/UpdateTextInsightFromCallTableDto.ts +++ b/src/api/types/UpdateTextInsightFromCallTableDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a text-value insight, including its queries, formula, time range, and name. + */ export interface UpdateTextInsightFromCallTableDto { /** This is the name of the Insight. */ name?: string | undefined; @@ -23,6 +26,7 @@ export interface UpdateTextInsightFromCallTableDto { * You can also use the query names as the variable in the formula. */ formula?: Record | undefined; + /** The time range used to query the text-value data. */ timeRange?: Vapi.InsightTimeRange | undefined; /** * These are the queries to run to generate the insight. diff --git a/src/api/types/UpdateTogetherAiCredentialDto.ts b/src/api/types/UpdateTogetherAiCredentialDto.ts index f44dce79..e0af5278 100644 --- a/src/api/types/UpdateTogetherAiCredentialDto.ts +++ b/src/api/types/UpdateTogetherAiCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateTogetherAiCredentialDto { + provider?: Vapi.UpdateTogetherAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateTogetherAiCredentialDtoProvider.ts b/src/api/types/UpdateTogetherAiCredentialDtoProvider.ts new file mode 100644 index 00000000..0e30177c --- /dev/null +++ b/src/api/types/UpdateTogetherAiCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateTogetherAiCredentialDtoProvider = { + TogetherAi: "together-ai", +} as const; +export type UpdateTogetherAiCredentialDtoProvider = + (typeof UpdateTogetherAiCredentialDtoProvider)[keyof typeof UpdateTogetherAiCredentialDtoProvider]; diff --git a/src/api/types/UpdateToolDraftDto.ts b/src/api/types/UpdateToolDraftDto.ts new file mode 100644 index 00000000..cc9003cc --- /dev/null +++ b/src/api/types/UpdateToolDraftDto.ts @@ -0,0 +1,156 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface UpdateToolDraftDto { + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ + messages?: Vapi.UpdateToolDraftDtoMessagesItem[] | undefined; + /** This is the type of the tool. */ + type?: Vapi.UpdateToolDraftDtoType | undefined; + /** This is the function definition of the tool. */ + function?: Vapi.OpenAiFunction | undefined; + /** + * Provider-specific metadata. Polymorphic across tool variants with no shared + * discriminator, so it is validated as a plain object (mirrors how + * `ToolCallResult.metadata` is typed). + */ + metadata?: Record | undefined; + /** This is the unique identifier for the template this tool was created from. */ + templateId?: string | undefined; + server?: Vapi.Server | undefined; + async?: boolean | undefined; + /** These are the destinations that the call can be transferred to. */ + destinations?: Record[] | undefined; + /** This is the name of the tool. This will be passed to the model. */ + name?: string | undefined; + /** This is the sub type of the tool (e.g. for computer, bash and text-editor tools). */ + subType?: string | undefined; + /** The display width in pixels (computer tool). */ + displayWidthPx?: number | undefined; + /** The display height in pixels (computer tool). */ + displayHeightPx?: number | undefined; + /** Optional display number (computer tool). */ + displayNumber?: number | undefined; + /** The knowledge bases to query (query tool). */ + knowledgeBases?: Vapi.KnowledgeBase[] | undefined; + /** This is where the request will be sent (api-request tool). */ + url?: string | undefined; + /** This is the HTTP method for the request (api-request tool). */ + method?: Vapi.UpdateToolDraftDtoMethod | undefined; + /** These are the headers to send with the request (api-request / sip-request tool). */ + headers?: Vapi.JsonSchema | undefined; + /** + * This is the body of the request. Either a JSON schema (api-request) or a + * literal string / schema (sip-request). + */ + body?: Record | undefined; + /** This is the backoff plan if the request fails. */ + backoffPlan?: Vapi.BackoffPlan | undefined; + /** This is the timeout in seconds for the request. */ + timeoutSeconds?: number | undefined; + /** This is the description of the tool. This will be passed to the model. */ + description?: string | undefined; + /** This is the plan to extract variables from the tool's response. */ + variableExtractionPlan?: Vapi.VariableExtractionPlan | undefined; + /** This is the credential ID that will be used for authorization. */ + credentialId?: string | undefined; + extendedDelayWhenPrecededByTextEnabled?: boolean | undefined; + beepDetectionEnabled?: boolean | undefined; + /** This is the TypeScript code that will be executed when the tool is called (code tool). */ + code?: string | undefined; + /** These are the environment variables available in the code via the `env` object (code tool). */ + environmentVariables?: Vapi.CodeToolEnvironmentVariable[] | undefined; + /** These are the static parameters to merge into the tool's request body. */ + parameters?: Vapi.ToolParameter[] | undefined; + /** This is the paths to encrypt in the request body. */ + encryptedPaths?: string[] | undefined; + /** This enables sending DTMF tones via SIP INFO messages instead of RFC 2833. */ + sipInfoDtmfEnabled?: boolean | undefined; + /** This is the SIP method to send (sip-request tool). */ + verb?: Vapi.UpdateToolDraftDtoVerb | undefined; + /** This is the default local tool result message used when no runtime override is returned (handoff tool). */ + defaultResult?: string | undefined; + /** Per-tool message overrides for individual tools loaded from the MCP server (mcp tool). */ + toolMessages?: Vapi.McpToolMessages[] | undefined; + /** + * This is the plan to reject a tool call based on the conversation state. + * + * // Example 1: Reject endCall if user didn't say goodbye + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '(?i)\\b(bye|goodbye|farewell|see you later|take care)\\b', + * target: { position: -1, role: 'user' }, + * negate: true // Reject if pattern does NOT match + * }] + * } + * ``` + * + * // Example 2: Reject transfer if user is actually asking a question + * ```json + * { + * conditions: [{ + * type: 'regex', + * regex: '\\?', + * target: { position: -1, role: 'user' } + * }] + * } + * ``` + * + * // Example 3: Reject transfer if user didn't mention transfer recently + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 5 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' %} + * {% assign mentioned = false %} + * {% for msg in userMessages %} + * {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %} + * {% assign mentioned = true %} + * {% break %} + * {% endif %} + * {% endfor %} + * {% if mentioned %} + * false + * {% else %} + * true + * {% endif %}` + * }] + * } + * ``` + * + * // Example 4: Reject endCall if the bot is looping and trying to exit + * ```json + * { + * conditions: [{ + * type: 'liquid', + * liquid: `{% assign recentMessages = messages | last: 6 %} + * {% assign userMessages = recentMessages | where: 'role', 'user' | reverse %} + * {% if userMessages.size < 3 %} + * false + * {% else %} + * {% assign msg1 = userMessages[0].content | downcase %} + * {% assign msg2 = userMessages[1].content | downcase %} + * {% assign msg3 = userMessages[2].content | downcase %} + * {% comment %} Check for repetitive messages {% endcomment %} + * {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %} + * true + * {% comment %} Check for common loop phrases {% endcomment %} + * {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %} + * true + * {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %} + * true + * {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %} + * true + * {% else %} + * false + * {% endif %} + * {% endif %}` + * }] + * } + * ``` + */ + rejectionPlan?: Vapi.ToolRejectionPlan | undefined; +} diff --git a/src/api/types/UpdateToolDraftDtoMessagesItem.ts b/src/api/types/UpdateToolDraftDtoMessagesItem.ts new file mode 100644 index 00000000..a2129aa9 --- /dev/null +++ b/src/api/types/UpdateToolDraftDtoMessagesItem.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export type UpdateToolDraftDtoMessagesItem = + | Vapi.UpdateToolDraftDtoMessagesItem.RequestStart + | Vapi.UpdateToolDraftDtoMessagesItem.RequestComplete + | Vapi.UpdateToolDraftDtoMessagesItem.RequestFailed + | Vapi.UpdateToolDraftDtoMessagesItem.RequestResponseDelayed; + +export namespace UpdateToolDraftDtoMessagesItem { + export interface RequestStart extends Vapi.ToolMessageStart { + type: "request-start"; + } + + export interface RequestComplete extends Vapi.ToolMessageComplete { + type: "request-complete"; + } + + export interface RequestFailed extends Vapi.ToolMessageFailed { + type: "request-failed"; + } + + export interface RequestResponseDelayed extends Vapi.ToolMessageDelayed { + type: "request-response-delayed"; + } +} diff --git a/src/api/types/UpdateToolDraftDtoMethod.ts b/src/api/types/UpdateToolDraftDtoMethod.ts new file mode 100644 index 00000000..8e4ecdc2 --- /dev/null +++ b/src/api/types/UpdateToolDraftDtoMethod.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the HTTP method for the request (api-request tool). */ +export const UpdateToolDraftDtoMethod = { + Post: "POST", + Get: "GET", + Put: "PUT", + Patch: "PATCH", + Delete: "DELETE", +} as const; +export type UpdateToolDraftDtoMethod = (typeof UpdateToolDraftDtoMethod)[keyof typeof UpdateToolDraftDtoMethod]; diff --git a/src/api/types/UpdateToolDraftDtoType.ts b/src/api/types/UpdateToolDraftDtoType.ts new file mode 100644 index 00000000..22e52f45 --- /dev/null +++ b/src/api/types/UpdateToolDraftDtoType.ts @@ -0,0 +1,35 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the type of the tool. */ +export const UpdateToolDraftDtoType = { + Dtmf: "dtmf", + EndCall: "endCall", + KnowledgeBase: "knowledgeBase", + TransferCall: "transferCall", + TransferCancel: "transferCancel", + TransferSuccessful: "transferSuccessful", + Handoff: "handoff", + Output: "output", + Voicemail: "voicemail", + Query: "query", + Sms: "sms", + SipRequest: "sipRequest", + Function: "function", + Mcp: "mcp", + ApiRequest: "apiRequest", + Code: "code", + Bash: "bash", + Computer: "computer", + TextEditor: "textEditor", + GoogleCalendarEventCreate: "google.calendar.event.create", + GoogleCalendarAvailabilityCheck: "google.calendar.availability.check", + GoogleSheetsRowAppend: "google.sheets.row.append", + SlackMessageSend: "slack.message.send", + GohighlevelCalendarEventCreate: "gohighlevel.calendar.event.create", + GohighlevelCalendarAvailabilityCheck: "gohighlevel.calendar.availability.check", + GohighlevelContactCreate: "gohighlevel.contact.create", + GohighlevelContactGet: "gohighlevel.contact.get", + Make: "make", + Ghl: "ghl", +} as const; +export type UpdateToolDraftDtoType = (typeof UpdateToolDraftDtoType)[keyof typeof UpdateToolDraftDtoType]; diff --git a/src/api/types/UpdateToolDraftDtoVerb.ts b/src/api/types/UpdateToolDraftDtoVerb.ts new file mode 100644 index 00000000..a9633932 --- /dev/null +++ b/src/api/types/UpdateToolDraftDtoVerb.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the SIP method to send (sip-request tool). */ +export const UpdateToolDraftDtoVerb = { + Info: "INFO", + Message: "MESSAGE", + Notify: "NOTIFY", +} as const; +export type UpdateToolDraftDtoVerb = (typeof UpdateToolDraftDtoVerb)[keyof typeof UpdateToolDraftDtoVerb]; diff --git a/src/api/types/UpdateToolTemplateDtoDetails.ts b/src/api/types/UpdateToolTemplateDtoDetails.ts index d56ab01a..4cea741a 100644 --- a/src/api/types/UpdateToolTemplateDtoDetails.ts +++ b/src/api/types/UpdateToolTemplateDtoDetails.ts @@ -119,4 +119,29 @@ export namespace UpdateToolTemplateDtoDetails { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.UpdateToolTemplateDtoDetails.ApiRequest + | Vapi.UpdateToolTemplateDtoDetails.Bash + | Vapi.UpdateToolTemplateDtoDetails.Code + | Vapi.UpdateToolTemplateDtoDetails.Computer + | Vapi.UpdateToolTemplateDtoDetails.Dtmf + | Vapi.UpdateToolTemplateDtoDetails.EndCall + | Vapi.UpdateToolTemplateDtoDetails.Function + | Vapi.UpdateToolTemplateDtoDetails.GohighlevelCalendarAvailabilityCheck + | Vapi.UpdateToolTemplateDtoDetails.GohighlevelCalendarEventCreate + | Vapi.UpdateToolTemplateDtoDetails.GohighlevelContactCreate + | Vapi.UpdateToolTemplateDtoDetails.GohighlevelContactGet + | Vapi.UpdateToolTemplateDtoDetails.GoogleCalendarAvailabilityCheck + | Vapi.UpdateToolTemplateDtoDetails.GoogleCalendarEventCreate + | Vapi.UpdateToolTemplateDtoDetails.GoogleSheetsRowAppend + | Vapi.UpdateToolTemplateDtoDetails.Handoff + | Vapi.UpdateToolTemplateDtoDetails.Mcp + | Vapi.UpdateToolTemplateDtoDetails.Query + | Vapi.UpdateToolTemplateDtoDetails.SlackMessageSend + | Vapi.UpdateToolTemplateDtoDetails.Sms + | Vapi.UpdateToolTemplateDtoDetails.TextEditor + | Vapi.UpdateToolTemplateDtoDetails.TransferCall + | Vapi.UpdateToolTemplateDtoDetails.SipRequest + | Vapi.UpdateToolTemplateDtoDetails.Voicemail; } diff --git a/src/api/types/UpdateToolVersionMetadataDto.ts b/src/api/types/UpdateToolVersionMetadataDto.ts new file mode 100644 index 00000000..a1caa67a --- /dev/null +++ b/src/api/types/UpdateToolVersionMetadataDto.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface UpdateToolVersionMetadataDto { + /** Optional human-readable label for this version. Pass `null` to clear. */ + versionName?: (string | null) | undefined; + /** Optional description for this version. Pass `null` to clear. */ + versionDescription?: (string | null) | undefined; +} diff --git a/src/api/types/UpdateTransferCallToolDto.ts b/src/api/types/UpdateTransferCallToolDto.ts index a70e45a9..615d6c4a 100644 --- a/src/api/types/UpdateTransferCallToolDto.ts +++ b/src/api/types/UpdateTransferCallToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan. + */ export interface UpdateTransferCallToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateTransferCallToolDtoMessagesItem[] | undefined; /** 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. */ destinations?: Vapi.UpdateTransferCallToolDtoDestinationsItem[] | undefined; diff --git a/src/api/types/UpdateTrieveCredentialDto.ts b/src/api/types/UpdateTrieveCredentialDto.ts deleted file mode 100644 index 5b2182cb..00000000 --- a/src/api/types/UpdateTrieveCredentialDto.ts +++ /dev/null @@ -1,8 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export interface UpdateTrieveCredentialDto { - /** This is not returned in the API. */ - apiKey?: string | undefined; - /** This is the name of credential. This is just for your reference. */ - name?: string | undefined; -} diff --git a/src/api/types/UpdateTrieveKnowledgeBaseDto.ts b/src/api/types/UpdateTrieveKnowledgeBaseDto.ts index cc6c2c93..e2b26c79 100644 --- a/src/api/types/UpdateTrieveKnowledgeBaseDto.ts +++ b/src/api/types/UpdateTrieveKnowledgeBaseDto.ts @@ -1,18 +1,3 @@ // This file was auto-generated by Fern from our API Definition. -import type * as Vapi from "../index.js"; - -export interface UpdateTrieveKnowledgeBaseDto { - /** This is the name of the knowledge base. */ - name?: string | undefined; - /** - * This is the searching plan used when searching for relevant chunks from the vector store. - * - * You should configure this if you're running into these issues: - * - Too much unnecessary context is being fed as knowledge base context. - * - Not enough relevant context is being fed as knowledge base context. - */ - searchPlan?: Vapi.TrieveKnowledgeBaseSearchPlan | undefined; - /** This is the plan if you want us to create/import a new vector store using Trieve. */ - createPlan?: Vapi.TrieveKnowledgeBaseImport | undefined; -} +export type UpdateTrieveKnowledgeBaseDto = unknown; diff --git a/src/api/types/UpdateTwilioCredentialDto.ts b/src/api/types/UpdateTwilioCredentialDto.ts index 1c4dddf7..d739eecb 100644 --- a/src/api/types/UpdateTwilioCredentialDto.ts +++ b/src/api/types/UpdateTwilioCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateTwilioCredentialDto { + provider?: Vapi.UpdateTwilioCredentialDtoProvider | undefined; /** This is not returned in the API. */ authToken?: string | undefined; /** This is not returned in the API. */ diff --git a/src/api/types/UpdateTwilioCredentialDtoProvider.ts b/src/api/types/UpdateTwilioCredentialDtoProvider.ts new file mode 100644 index 00000000..ebaac5fb --- /dev/null +++ b/src/api/types/UpdateTwilioCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateTwilioCredentialDtoProvider = { + Twilio: "twilio", +} as const; +export type UpdateTwilioCredentialDtoProvider = + (typeof UpdateTwilioCredentialDtoProvider)[keyof typeof UpdateTwilioCredentialDtoProvider]; diff --git a/src/api/types/UpdateTwilioPhoneNumberDto.ts b/src/api/types/UpdateTwilioPhoneNumberDto.ts index e1f0ccdc..ca802412 100644 --- a/src/api/types/UpdateTwilioPhoneNumberDto.ts +++ b/src/api/types/UpdateTwilioPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings. + */ export interface UpdateTwilioPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateUserRoleDtoRole.ts b/src/api/types/UpdateUserRoleDtoRole.ts index d4c9dfcc..62c0af2a 100644 --- a/src/api/types/UpdateUserRoleDtoRole.ts +++ b/src/api/types/UpdateUserRoleDtoRole.ts @@ -1,8 +1,5 @@ // This file was auto-generated by Fern from our API Definition. -export const UpdateUserRoleDtoRole = { - Admin: "admin", - Editor: "editor", - Viewer: "viewer", -} as const; -export type UpdateUserRoleDtoRole = (typeof UpdateUserRoleDtoRole)[keyof typeof UpdateUserRoleDtoRole]; +import type * as Vapi from "../index.js"; + +export type UpdateUserRoleDtoRole = Vapi.UpdateUserRoleDtoRoleZero | string; diff --git a/src/api/types/UpdateUserRoleDtoRoleZero.ts b/src/api/types/UpdateUserRoleDtoRoleZero.ts new file mode 100644 index 00000000..d92a69f4 --- /dev/null +++ b/src/api/types/UpdateUserRoleDtoRoleZero.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateUserRoleDtoRoleZero = { + Admin: "admin", + Editor: "editor", + Viewer: "viewer", +} as const; +export type UpdateUserRoleDtoRoleZero = (typeof UpdateUserRoleDtoRoleZero)[keyof typeof UpdateUserRoleDtoRoleZero]; diff --git a/src/api/types/UpdateVapiPhoneNumberDto.ts b/src/api/types/UpdateVapiPhoneNumberDto.ts index 65fdce29..adbcceee 100644 --- a/src/api/types/UpdateVapiPhoneNumberDto.ts +++ b/src/api/types/UpdateVapiPhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings. + */ export interface UpdateVapiPhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateVoiceLibraryMetadataDto.ts b/src/api/types/UpdateVoiceLibraryMetadataDto.ts new file mode 100644 index 00000000..318c953e --- /dev/null +++ b/src/api/types/UpdateVoiceLibraryMetadataDto.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface UpdateVoiceLibraryMetadataDto { + /** Updated display name for the voice. */ + name?: string | undefined; + /** Updated description for the voice. */ + description?: string | undefined; +} diff --git a/src/api/types/UpdateVoicemailToolDto.ts b/src/api/types/UpdateVoicemailToolDto.ts index cce6fd97..21c310fe 100644 --- a/src/api/types/UpdateVoicemailToolDto.ts +++ b/src/api/types/UpdateVoicemailToolDto.ts @@ -2,12 +2,11 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan. + */ export interface UpdateVoicemailToolDto { - /** - * 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. - */ + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.UpdateVoicemailToolDtoMessagesItem[] | undefined; /** * This is the flag that enables beep detection for voicemail detection and applies only for twilio based calls. diff --git a/src/api/types/UpdateVonageCredentialDto.ts b/src/api/types/UpdateVonageCredentialDto.ts index a8b451c8..e500ac6a 100644 --- a/src/api/types/UpdateVonageCredentialDto.ts +++ b/src/api/types/UpdateVonageCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateVonageCredentialDto { + provider?: Vapi.UpdateVonageCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiSecret?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateVonageCredentialDtoProvider.ts b/src/api/types/UpdateVonageCredentialDtoProvider.ts new file mode 100644 index 00000000..09dbfe48 --- /dev/null +++ b/src/api/types/UpdateVonageCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateVonageCredentialDtoProvider = { + Vonage: "vonage", +} as const; +export type UpdateVonageCredentialDtoProvider = + (typeof UpdateVonageCredentialDtoProvider)[keyof typeof UpdateVonageCredentialDtoProvider]; diff --git a/src/api/types/UpdateVonagePhoneNumberDto.ts b/src/api/types/UpdateVonagePhoneNumberDto.ts index e913675e..cadc42c9 100644 --- a/src/api/types/UpdateVonagePhoneNumberDto.ts +++ b/src/api/types/UpdateVonagePhoneNumberDto.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings. + */ export interface UpdateVonagePhoneNumberDto { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/UpdateWebhookCredentialDto.ts b/src/api/types/UpdateWebhookCredentialDto.ts index 0be66c66..8917e769 100644 --- a/src/api/types/UpdateWebhookCredentialDto.ts +++ b/src/api/types/UpdateWebhookCredentialDto.ts @@ -3,6 +3,7 @@ import type * as Vapi from "../index.js"; export interface UpdateWebhookCredentialDto { + provider?: Vapi.UpdateWebhookCredentialDtoProvider | undefined; /** This is the authentication plan. Supports OAuth2 RFC 6749, HMAC signing, and Bearer authentication. */ authenticationPlan?: Vapi.UpdateWebhookCredentialDtoAuthenticationPlan | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateWebhookCredentialDtoProvider.ts b/src/api/types/UpdateWebhookCredentialDtoProvider.ts new file mode 100644 index 00000000..686a5961 --- /dev/null +++ b/src/api/types/UpdateWebhookCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateWebhookCredentialDtoProvider = { + Webhook: "webhook", +} as const; +export type UpdateWebhookCredentialDtoProvider = + (typeof UpdateWebhookCredentialDtoProvider)[keyof typeof UpdateWebhookCredentialDtoProvider]; diff --git a/src/api/types/UpdateWellSaidCredentialDto.ts b/src/api/types/UpdateWellSaidCredentialDto.ts index e5027469..7f39239b 100644 --- a/src/api/types/UpdateWellSaidCredentialDto.ts +++ b/src/api/types/UpdateWellSaidCredentialDto.ts @@ -1,6 +1,9 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateWellSaidCredentialDto { + provider?: Vapi.UpdateWellSaidCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateWellSaidCredentialDtoProvider.ts b/src/api/types/UpdateWellSaidCredentialDtoProvider.ts new file mode 100644 index 00000000..2988cce9 --- /dev/null +++ b/src/api/types/UpdateWellSaidCredentialDtoProvider.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const UpdateWellSaidCredentialDtoProvider = { + Wellsaid: "wellsaid", +} as const; +export type UpdateWellSaidCredentialDtoProvider = + (typeof UpdateWellSaidCredentialDtoProvider)[keyof typeof UpdateWellSaidCredentialDtoProvider]; diff --git a/src/api/types/UpdateWorkflowDtoCredentialsItem.ts b/src/api/types/UpdateWorkflowDtoCredentialsItem.ts index 0876d84e..0fb3aa80 100644 --- a/src/api/types/UpdateWorkflowDtoCredentialsItem.ts +++ b/src/api/types/UpdateWorkflowDtoCredentialsItem.ts @@ -34,6 +34,7 @@ export type UpdateWorkflowDtoCredentialsItem = | Vapi.UpdateWorkflowDtoCredentialsItem.RimeAi | Vapi.UpdateWorkflowDtoCredentialsItem.Runpod | Vapi.UpdateWorkflowDtoCredentialsItem.S3 + | Vapi.UpdateWorkflowDtoCredentialsItem.S3Compatible | Vapi.UpdateWorkflowDtoCredentialsItem.Supabase | Vapi.UpdateWorkflowDtoCredentialsItem.SmallestAi | Vapi.UpdateWorkflowDtoCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type UpdateWorkflowDtoCredentialsItem = | Vapi.UpdateWorkflowDtoCredentialsItem.Webhook | Vapi.UpdateWorkflowDtoCredentialsItem.CustomCredential | Vapi.UpdateWorkflowDtoCredentialsItem.Xai + | Vapi.UpdateWorkflowDtoCredentialsItem.Microsoft | Vapi.UpdateWorkflowDtoCredentialsItem.Neuphonic | Vapi.UpdateWorkflowDtoCredentialsItem.Hume | Vapi.UpdateWorkflowDtoCredentialsItem.Mistral | Vapi.UpdateWorkflowDtoCredentialsItem.Speechmatics | Vapi.UpdateWorkflowDtoCredentialsItem.Soniox - | Vapi.UpdateWorkflowDtoCredentialsItem.Trieve | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Client | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace UpdateWorkflowDtoCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace UpdateWorkflowDtoCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace UpdateWorkflowDtoCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace UpdateWorkflowDtoCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.UpdateWorkflowDtoCredentialsItem._11Labs + | Vapi.UpdateWorkflowDtoCredentialsItem.Anthropic + | Vapi.UpdateWorkflowDtoCredentialsItem.AnthropicBedrock + | Vapi.UpdateWorkflowDtoCredentialsItem.Anyscale + | Vapi.UpdateWorkflowDtoCredentialsItem.AssemblyAi + | Vapi.UpdateWorkflowDtoCredentialsItem.AzureOpenai + | Vapi.UpdateWorkflowDtoCredentialsItem.Azure + | Vapi.UpdateWorkflowDtoCredentialsItem.ByoSipTrunk + | Vapi.UpdateWorkflowDtoCredentialsItem.Cartesia + | Vapi.UpdateWorkflowDtoCredentialsItem.Cerebras + | Vapi.UpdateWorkflowDtoCredentialsItem.Cloudflare + | Vapi.UpdateWorkflowDtoCredentialsItem.CustomLlm + | Vapi.UpdateWorkflowDtoCredentialsItem.Deepgram + | Vapi.UpdateWorkflowDtoCredentialsItem.Deepinfra + | Vapi.UpdateWorkflowDtoCredentialsItem.DeepSeek + | Vapi.UpdateWorkflowDtoCredentialsItem.Gcp + | Vapi.UpdateWorkflowDtoCredentialsItem.Gladia + | Vapi.UpdateWorkflowDtoCredentialsItem.Gohighlevel + | Vapi.UpdateWorkflowDtoCredentialsItem.Google + | Vapi.UpdateWorkflowDtoCredentialsItem.Groq + | Vapi.UpdateWorkflowDtoCredentialsItem.InflectionAi + | Vapi.UpdateWorkflowDtoCredentialsItem.Langfuse + | Vapi.UpdateWorkflowDtoCredentialsItem.Lmnt + | Vapi.UpdateWorkflowDtoCredentialsItem.Make + | Vapi.UpdateWorkflowDtoCredentialsItem.Openai + | Vapi.UpdateWorkflowDtoCredentialsItem.Openrouter + | Vapi.UpdateWorkflowDtoCredentialsItem.PerplexityAi + | Vapi.UpdateWorkflowDtoCredentialsItem.Playht + | Vapi.UpdateWorkflowDtoCredentialsItem.RimeAi + | Vapi.UpdateWorkflowDtoCredentialsItem.Runpod + | Vapi.UpdateWorkflowDtoCredentialsItem.S3 + | Vapi.UpdateWorkflowDtoCredentialsItem.S3Compatible + | Vapi.UpdateWorkflowDtoCredentialsItem.Supabase + | Vapi.UpdateWorkflowDtoCredentialsItem.SmallestAi + | Vapi.UpdateWorkflowDtoCredentialsItem.Tavus + | Vapi.UpdateWorkflowDtoCredentialsItem.TogetherAi + | Vapi.UpdateWorkflowDtoCredentialsItem.Twilio + | Vapi.UpdateWorkflowDtoCredentialsItem.Vonage + | Vapi.UpdateWorkflowDtoCredentialsItem.Webhook + | Vapi.UpdateWorkflowDtoCredentialsItem.CustomCredential + | Vapi.UpdateWorkflowDtoCredentialsItem.Xai + | Vapi.UpdateWorkflowDtoCredentialsItem.Microsoft + | Vapi.UpdateWorkflowDtoCredentialsItem.Neuphonic + | Vapi.UpdateWorkflowDtoCredentialsItem.Hume + | Vapi.UpdateWorkflowDtoCredentialsItem.Mistral + | Vapi.UpdateWorkflowDtoCredentialsItem.Speechmatics + | Vapi.UpdateWorkflowDtoCredentialsItem.Soniox + | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Client + | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.UpdateWorkflowDtoCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.UpdateWorkflowDtoCredentialsItem.SlackOauth2Authorization + | Vapi.UpdateWorkflowDtoCredentialsItem.GhlOauth2Authorization + | Vapi.UpdateWorkflowDtoCredentialsItem.Inworld + | Vapi.UpdateWorkflowDtoCredentialsItem.Minimax + | Vapi.UpdateWorkflowDtoCredentialsItem.Wellsaid + | Vapi.UpdateWorkflowDtoCredentialsItem.Email + | Vapi.UpdateWorkflowDtoCredentialsItem.SlackWebhook; } diff --git a/src/api/types/UpdateWorkflowDtoNodesItem.ts b/src/api/types/UpdateWorkflowDtoNodesItem.ts index cd0dfe64..dafd7d5e 100644 --- a/src/api/types/UpdateWorkflowDtoNodesItem.ts +++ b/src/api/types/UpdateWorkflowDtoNodesItem.ts @@ -14,4 +14,6 @@ export namespace UpdateWorkflowDtoNodesItem { export interface Tool extends Vapi.ToolNode { type: "tool"; } + + export type Response = Vapi.UpdateWorkflowDtoNodesItem.Conversation | Vapi.UpdateWorkflowDtoNodesItem.Tool; } diff --git a/src/api/types/UpdateWorkflowDtoTranscriber.ts b/src/api/types/UpdateWorkflowDtoTranscriber.ts index 4d2d7c43..eb854922 100644 --- a/src/api/types/UpdateWorkflowDtoTranscriber.ts +++ b/src/api/types/UpdateWorkflowDtoTranscriber.ts @@ -19,7 +19,9 @@ export type UpdateWorkflowDtoTranscriber = | Vapi.UpdateWorkflowDtoTranscriber.Talkscriber | Vapi.UpdateWorkflowDtoTranscriber.Openai | Vapi.UpdateWorkflowDtoTranscriber.Cartesia - | Vapi.UpdateWorkflowDtoTranscriber.Soniox; + | Vapi.UpdateWorkflowDtoTranscriber.Soniox + | Vapi.UpdateWorkflowDtoTranscriber.Xai + | Vapi.UpdateWorkflowDtoTranscriber.Vapi; export namespace UpdateWorkflowDtoTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -69,4 +71,12 @@ export namespace UpdateWorkflowDtoTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/UpdateWorkflowDtoVoice.ts b/src/api/types/UpdateWorkflowDtoVoice.ts index 8d3e6197..c0bc263b 100644 --- a/src/api/types/UpdateWorkflowDtoVoice.ts +++ b/src/api/types/UpdateWorkflowDtoVoice.ts @@ -25,7 +25,9 @@ export type UpdateWorkflowDtoVoice = | Vapi.UpdateWorkflowDtoVoice.Vapi | Vapi.UpdateWorkflowDtoVoice.Sesame | Vapi.UpdateWorkflowDtoVoice.Inworld - | Vapi.UpdateWorkflowDtoVoice.Minimax; + | Vapi.UpdateWorkflowDtoVoice.Minimax + | Vapi.UpdateWorkflowDtoVoice.Xai + | Vapi.UpdateWorkflowDtoVoice.Microsoft; export namespace UpdateWorkflowDtoVoice { export interface Azure extends Vapi.AzureVoice { @@ -99,4 +101,12 @@ export namespace UpdateWorkflowDtoVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/UpdateXAiCredentialDto.ts b/src/api/types/UpdateXAiCredentialDto.ts index a9b23607..406a402b 100644 --- a/src/api/types/UpdateXAiCredentialDto.ts +++ b/src/api/types/UpdateXAiCredentialDto.ts @@ -1,6 +1,10 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface UpdateXAiCredentialDto { + /** This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai */ + provider?: Vapi.UpdateXAiCredentialDtoProvider | undefined; /** This is not returned in the API. */ apiKey?: string | undefined; /** This is the name of credential. This is just for your reference. */ diff --git a/src/api/types/UpdateXAiCredentialDtoProvider.ts b/src/api/types/UpdateXAiCredentialDtoProvider.ts new file mode 100644 index 00000000..72d80df2 --- /dev/null +++ b/src/api/types/UpdateXAiCredentialDtoProvider.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the api key for Grok in XAi's console. Get it from here: https://console.x.ai */ +export const UpdateXAiCredentialDtoProvider = { + Xai: "xai", +} as const; +export type UpdateXAiCredentialDtoProvider = + (typeof UpdateXAiCredentialDtoProvider)[keyof typeof UpdateXAiCredentialDtoProvider]; diff --git a/src/api/types/UserMessage.ts b/src/api/types/UserMessage.ts index bf2b2a67..d6a7bf3e 100644 --- a/src/api/types/UserMessage.ts +++ b/src/api/types/UserMessage.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * A user-authored entry in the call message history, including content, timing, security-filter results, and optional speaker metadata. + */ export interface UserMessage { /** The role of the user in the conversation. */ role: string; diff --git a/src/api/types/VapiCost.ts b/src/api/types/VapiCost.ts index 9c08b1f2..9c8565c1 100644 --- a/src/api/types/VapiCost.ts +++ b/src/api/types/VapiCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Vapi platform cost for a call, including cost subtype, billable minutes, and amount. + */ export interface VapiCost { /** This is the sub type of the cost. */ subType: Vapi.VapiCostSubType; diff --git a/src/api/types/VapiModel.ts b/src/api/types/VapiModel.ts index 13e8a890..e64203ae 100644 --- a/src/api/types/VapiModel.ts +++ b/src/api/types/VapiModel.ts @@ -17,19 +17,37 @@ export interface VapiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; - provider: Vapi.VapiModelProvider; + /** + * White-label Vapi models are selected by `version`, not a model name, so + * `model` is optional here (the runtime already accepts a version-only Vapi + * payload). Overriding the required `ModelBase.model`: the declared type stays + * `string` to match the base (avoids TS2416) and the `= undefined!` initializer + * satisfies TS2612 for the field override, while `@IsOptional` + + * `@ApiPropertyOptional` make validation and the generated OpenAPI schema treat + * it as optional (so `VapiModel.required` is `['provider']`). + */ + model?: string | undefined; + /** + * Vapi-managed model version (update channel). When set, this is a Vapi-managed + * LLM routed by the registry; when absent, this is the legacy workflow form + * below (`steps` / `workflow`). + */ + version?: Vapi.VapiModelVersion | undefined; /** This is the workflow that will be used for the call. To use a transient workflow, use `workflow` instead. */ workflowId?: string | undefined; /** This is the workflow that will be used for the call. To use an existing workflow, use `workflowId` instead. */ workflow?: Vapi.WorkflowUserEditable | undefined; - /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ - model: string; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; - /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ - maxTokens?: number | undefined; /** * This determines whether we detect user's emotion while they speak and send it as an additional info to model. * diff --git a/src/api/types/VapiModelProvider.ts b/src/api/types/VapiModelProvider.ts deleted file mode 100644 index db9275ed..00000000 --- a/src/api/types/VapiModelProvider.ts +++ /dev/null @@ -1,6 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -export const VapiModelProvider = { - Vapi: "vapi", -} as const; -export type VapiModelProvider = (typeof VapiModelProvider)[keyof typeof VapiModelProvider]; diff --git a/src/api/types/VapiModelToolsItem.ts b/src/api/types/VapiModelToolsItem.ts index 65df7e92..88bb3c33 100644 --- a/src/api/types/VapiModelToolsItem.ts +++ b/src/api/types/VapiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace VapiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.VapiModelToolsItem.ApiRequest + | Vapi.VapiModelToolsItem.Bash + | Vapi.VapiModelToolsItem.Code + | Vapi.VapiModelToolsItem.Computer + | Vapi.VapiModelToolsItem.Dtmf + | Vapi.VapiModelToolsItem.EndCall + | Vapi.VapiModelToolsItem.Function + | Vapi.VapiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.VapiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.VapiModelToolsItem.GohighlevelContactCreate + | Vapi.VapiModelToolsItem.GohighlevelContactGet + | Vapi.VapiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.VapiModelToolsItem.GoogleCalendarEventCreate + | Vapi.VapiModelToolsItem.GoogleSheetsRowAppend + | Vapi.VapiModelToolsItem.Handoff + | Vapi.VapiModelToolsItem.Mcp + | Vapi.VapiModelToolsItem.Query + | Vapi.VapiModelToolsItem.SlackMessageSend + | Vapi.VapiModelToolsItem.Sms + | Vapi.VapiModelToolsItem.TextEditor + | Vapi.VapiModelToolsItem.TransferCall + | Vapi.VapiModelToolsItem.SipRequest + | Vapi.VapiModelToolsItem.Voicemail; } diff --git a/src/api/types/VapiModelVersion.ts b/src/api/types/VapiModelVersion.ts new file mode 100644 index 00000000..cfb59c80 --- /dev/null +++ b/src/api/types/VapiModelVersion.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * Vapi-managed model version (update channel). When set, this is a Vapi-managed + * LLM routed by the registry; when absent, this is the legacy workflow form + * below (`steps` / `workflow`). + */ +export const VapiModelVersion = { + Latest: "latest", + One: "1", +} as const; +export type VapiModelVersion = (typeof VapiModelVersion)[keyof typeof VapiModelVersion]; diff --git a/src/api/types/VapiPhoneNumber.ts b/src/api/types/VapiPhoneNumber.ts index 2046233e..bcb0a328 100644 --- a/src/api/types/VapiPhoneNumber.ts +++ b/src/api/types/VapiPhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata. + */ export interface VapiPhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/VapiPronunciationDictionaryLocator.ts b/src/api/types/VapiPronunciationDictionaryLocator.ts index 89ae4b33..83f3ea68 100644 --- a/src/api/types/VapiPronunciationDictionaryLocator.ts +++ b/src/api/types/VapiPronunciationDictionaryLocator.ts @@ -1,8 +1,15 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + +/** + * Identifies a pronunciation dictionary and optional version used for voice synthesis. + */ export interface VapiPronunciationDictionaryLocator { /** The pronunciation dictionary ID */ pronunciationDictId: string; - /** Version ID (only required for ElevenLabs, ignored for Cartesia) */ + /** Version ID (only used by ElevenLabs, ignored for Cartesia) */ versionId?: string | undefined; + /** Provider that hosts this pronunciation dictionary */ + provider?: Vapi.VapiPronunciationDictionaryLocatorProvider | undefined; } diff --git a/src/api/types/VapiPronunciationDictionaryLocatorProvider.ts b/src/api/types/VapiPronunciationDictionaryLocatorProvider.ts new file mode 100644 index 00000000..aedff6b4 --- /dev/null +++ b/src/api/types/VapiPronunciationDictionaryLocatorProvider.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Provider that hosts this pronunciation dictionary */ +export const VapiPronunciationDictionaryLocatorProvider = { + Cartesia: "cartesia", + ElevenLabs: "11labs", +} as const; +export type VapiPronunciationDictionaryLocatorProvider = + (typeof VapiPronunciationDictionaryLocatorProvider)[keyof typeof VapiPronunciationDictionaryLocatorProvider]; diff --git a/src/api/types/VapiSipTransport.ts b/src/api/types/VapiSipTransport.ts new file mode 100644 index 00000000..bac9b645 --- /dev/null +++ b/src/api/types/VapiSipTransport.ts @@ -0,0 +1,18 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VapiSipTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.VapiSipTransportConversationType | undefined; + /** + * This sets the timeout for outbound dial operations in seconds. This is the duration the call will ring before timing out. + * + * @default 60 + */ + dialTimeout?: number | undefined; + /** This is the call SID of the Vapi SIP call. */ + sbcCallSid?: string | undefined; + /** This is the call ID of the Vapi SIP call. */ + callSid?: string | undefined; +} diff --git a/src/api/types/VapiSipTransportConversationType.ts b/src/api/types/VapiSipTransportConversationType.ts new file mode 100644 index 00000000..4b7ff21f --- /dev/null +++ b/src/api/types/VapiSipTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const VapiSipTransportConversationType = { + Voice: "voice", +} as const; +export type VapiSipTransportConversationType = + (typeof VapiSipTransportConversationType)[keyof typeof VapiSipTransportConversationType]; diff --git a/src/api/types/VapiSmartEndpointingPlan.ts b/src/api/types/VapiSmartEndpointingPlan.ts index f8e2cdcc..94fe1763 100644 --- a/src/api/types/VapiSmartEndpointingPlan.ts +++ b/src/api/types/VapiSmartEndpointingPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Selects Vapi smart endpointing to determine when customer speech is complete. + */ export interface VapiSmartEndpointingPlan { /** This is the provider for the smart endpointing plan. */ provider: Vapi.VapiSmartEndpointingPlanProvider; diff --git a/src/api/types/VapiTranscriber.ts b/src/api/types/VapiTranscriber.ts new file mode 100644 index 00000000..69000837 --- /dev/null +++ b/src/api/types/VapiTranscriber.ts @@ -0,0 +1,39 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VapiTranscriber { + /** + * This is the version of the Vapi transcriber. Vapi manages the underlying + * model and routing. When omitted, the latest version is used. + * + * Managed version params are additive-only and `'latest'` is an auto-update + * channel — see the param-evolution INVARIANT in `vapiManaged/types.ts`. + */ + version?: Vapi.VapiTranscriberVersion | undefined; + /** + * This is the language for transcription as an ISO 639-1 code (e.g. `en`). + * Selecting a language locks transcription to it. For multiple languages, + * use `languages` instead. When neither `language` nor `languages` is set, + * the transcriber auto-detects the spoken language. + */ + language?: Vapi.VapiTranscriberLanguage | undefined; + /** + * These are the languages for transcription as ISO 639-1 codes. Set one or + * more codes to restrict and bias recognition to those languages. An empty + * array `[]` (or omitting both this and `language`) enables auto-detection + * of the spoken language. + */ + languages?: Vapi.VapiTranscriberLanguagesItem[] | undefined; + /** + * These are custom keywords/vocabulary to boost recognition of use-case + * specific words (company names, product names, jargon). + */ + keywords?: string[] | undefined; + /** + * This is the turn-taking mode. `intelligent` uses the underlying model's + * native end-of-turn detection; `manual` ignores it and waits a fixed + * end-of-turn delay. Defaults to `intelligent`. + */ + turnTaking?: Vapi.VapiTranscriberTurnTaking | undefined; +} diff --git a/src/api/types/VapiTranscriberLanguage.ts b/src/api/types/VapiTranscriberLanguage.ts new file mode 100644 index 00000000..0be489bb --- /dev/null +++ b/src/api/types/VapiTranscriberLanguage.ts @@ -0,0 +1,196 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the language for transcription as an ISO 639-1 code (e.g. `en`). + * Selecting a language locks transcription to it. For multiple languages, + * use `languages` instead. When neither `language` nor `languages` is set, + * the transcriber auto-detects the spoken language. + */ +export const VapiTranscriberLanguage = { + Aa: "aa", + Ab: "ab", + Ae: "ae", + Af: "af", + Ak: "ak", + Am: "am", + An: "an", + Ar: "ar", + As: "as", + Av: "av", + Ay: "ay", + Az: "az", + Ba: "ba", + Be: "be", + Bg: "bg", + Bh: "bh", + Bi: "bi", + Bm: "bm", + Bn: "bn", + Bo: "bo", + Br: "br", + Bs: "bs", + Ca: "ca", + Ce: "ce", + Ch: "ch", + Co: "co", + Cr: "cr", + Cs: "cs", + Cu: "cu", + Cv: "cv", + Cy: "cy", + Da: "da", + De: "de", + Dv: "dv", + Dz: "dz", + Ee: "ee", + El: "el", + En: "en", + Eo: "eo", + Es: "es", + Et: "et", + Eu: "eu", + Fa: "fa", + Ff: "ff", + Fi: "fi", + Fj: "fj", + Fo: "fo", + Fr: "fr", + Fy: "fy", + Ga: "ga", + Gd: "gd", + Gl: "gl", + Gn: "gn", + Gu: "gu", + Gv: "gv", + Ha: "ha", + He: "he", + Hi: "hi", + Ho: "ho", + Hr: "hr", + Ht: "ht", + Hu: "hu", + Hy: "hy", + Hz: "hz", + Ia: "ia", + Id: "id", + Ie: "ie", + Ig: "ig", + Ii: "ii", + Ik: "ik", + Io: "io", + Is: "is", + It: "it", + Iu: "iu", + Ja: "ja", + Jv: "jv", + Ka: "ka", + Kg: "kg", + Ki: "ki", + Kj: "kj", + Kk: "kk", + Kl: "kl", + Km: "km", + Kn: "kn", + Ko: "ko", + Kr: "kr", + Ks: "ks", + Ku: "ku", + Kv: "kv", + Kw: "kw", + Ky: "ky", + La: "la", + Lb: "lb", + Lg: "lg", + Li: "li", + Ln: "ln", + Lo: "lo", + Lt: "lt", + Lu: "lu", + Lv: "lv", + Mg: "mg", + Mh: "mh", + Mi: "mi", + Mk: "mk", + Ml: "ml", + Mn: "mn", + Mr: "mr", + Ms: "ms", + Mt: "mt", + My: "my", + Na: "na", + Nb: "nb", + Nd: "nd", + Ne: "ne", + Ng: "ng", + Nl: "nl", + Nn: "nn", + No: "no", + Nr: "nr", + Nv: "nv", + Ny: "ny", + Oc: "oc", + Oj: "oj", + Om: "om", + Or: "or", + Os: "os", + Pa: "pa", + Pi: "pi", + Pl: "pl", + Ps: "ps", + Pt: "pt", + Qu: "qu", + Rm: "rm", + Rn: "rn", + Ro: "ro", + Ru: "ru", + Rw: "rw", + Sa: "sa", + Sc: "sc", + Sd: "sd", + Se: "se", + Sg: "sg", + Si: "si", + Sk: "sk", + Sl: "sl", + Sm: "sm", + Sn: "sn", + So: "so", + Sq: "sq", + Sr: "sr", + Ss: "ss", + St: "st", + Su: "su", + Sv: "sv", + Sw: "sw", + Ta: "ta", + Te: "te", + Tg: "tg", + Th: "th", + Ti: "ti", + Tk: "tk", + Tl: "tl", + Tn: "tn", + To: "to", + Tr: "tr", + Ts: "ts", + Tt: "tt", + Tw: "tw", + Ty: "ty", + Ug: "ug", + Uk: "uk", + Ur: "ur", + Uz: "uz", + Ve: "ve", + Vi: "vi", + Vo: "vo", + Wa: "wa", + Wo: "wo", + Xh: "xh", + Yi: "yi", + Yue: "yue", + Yo: "yo", + Za: "za", + Zh: "zh", + Zu: "zu", +} as const; +export type VapiTranscriberLanguage = (typeof VapiTranscriberLanguage)[keyof typeof VapiTranscriberLanguage]; diff --git a/src/api/types/VapiTranscriberLanguagesItem.ts b/src/api/types/VapiTranscriberLanguagesItem.ts new file mode 100644 index 00000000..f3fd60f0 --- /dev/null +++ b/src/api/types/VapiTranscriberLanguagesItem.ts @@ -0,0 +1,191 @@ +// This file was auto-generated by Fern from our API Definition. + +export const VapiTranscriberLanguagesItem = { + Aa: "aa", + Ab: "ab", + Ae: "ae", + Af: "af", + Ak: "ak", + Am: "am", + An: "an", + Ar: "ar", + As: "as", + Av: "av", + Ay: "ay", + Az: "az", + Ba: "ba", + Be: "be", + Bg: "bg", + Bh: "bh", + Bi: "bi", + Bm: "bm", + Bn: "bn", + Bo: "bo", + Br: "br", + Bs: "bs", + Ca: "ca", + Ce: "ce", + Ch: "ch", + Co: "co", + Cr: "cr", + Cs: "cs", + Cu: "cu", + Cv: "cv", + Cy: "cy", + Da: "da", + De: "de", + Dv: "dv", + Dz: "dz", + Ee: "ee", + El: "el", + En: "en", + Eo: "eo", + Es: "es", + Et: "et", + Eu: "eu", + Fa: "fa", + Ff: "ff", + Fi: "fi", + Fj: "fj", + Fo: "fo", + Fr: "fr", + Fy: "fy", + Ga: "ga", + Gd: "gd", + Gl: "gl", + Gn: "gn", + Gu: "gu", + Gv: "gv", + Ha: "ha", + He: "he", + Hi: "hi", + Ho: "ho", + Hr: "hr", + Ht: "ht", + Hu: "hu", + Hy: "hy", + Hz: "hz", + Ia: "ia", + Id: "id", + Ie: "ie", + Ig: "ig", + Ii: "ii", + Ik: "ik", + Io: "io", + Is: "is", + It: "it", + Iu: "iu", + Ja: "ja", + Jv: "jv", + Ka: "ka", + Kg: "kg", + Ki: "ki", + Kj: "kj", + Kk: "kk", + Kl: "kl", + Km: "km", + Kn: "kn", + Ko: "ko", + Kr: "kr", + Ks: "ks", + Ku: "ku", + Kv: "kv", + Kw: "kw", + Ky: "ky", + La: "la", + Lb: "lb", + Lg: "lg", + Li: "li", + Ln: "ln", + Lo: "lo", + Lt: "lt", + Lu: "lu", + Lv: "lv", + Mg: "mg", + Mh: "mh", + Mi: "mi", + Mk: "mk", + Ml: "ml", + Mn: "mn", + Mr: "mr", + Ms: "ms", + Mt: "mt", + My: "my", + Na: "na", + Nb: "nb", + Nd: "nd", + Ne: "ne", + Ng: "ng", + Nl: "nl", + Nn: "nn", + No: "no", + Nr: "nr", + Nv: "nv", + Ny: "ny", + Oc: "oc", + Oj: "oj", + Om: "om", + Or: "or", + Os: "os", + Pa: "pa", + Pi: "pi", + Pl: "pl", + Ps: "ps", + Pt: "pt", + Qu: "qu", + Rm: "rm", + Rn: "rn", + Ro: "ro", + Ru: "ru", + Rw: "rw", + Sa: "sa", + Sc: "sc", + Sd: "sd", + Se: "se", + Sg: "sg", + Si: "si", + Sk: "sk", + Sl: "sl", + Sm: "sm", + Sn: "sn", + So: "so", + Sq: "sq", + Sr: "sr", + Ss: "ss", + St: "st", + Su: "su", + Sv: "sv", + Sw: "sw", + Ta: "ta", + Te: "te", + Tg: "tg", + Th: "th", + Ti: "ti", + Tk: "tk", + Tl: "tl", + Tn: "tn", + To: "to", + Tr: "tr", + Ts: "ts", + Tt: "tt", + Tw: "tw", + Ty: "ty", + Ug: "ug", + Uk: "uk", + Ur: "ur", + Uz: "uz", + Ve: "ve", + Vi: "vi", + Vo: "vo", + Wa: "wa", + Wo: "wo", + Xh: "xh", + Yi: "yi", + Yue: "yue", + Yo: "yo", + Za: "za", + Zh: "zh", + Zu: "zu", +} as const; +export type VapiTranscriberLanguagesItem = + (typeof VapiTranscriberLanguagesItem)[keyof typeof VapiTranscriberLanguagesItem]; diff --git a/src/api/types/VapiTranscriberTurnTaking.ts b/src/api/types/VapiTranscriberTurnTaking.ts new file mode 100644 index 00000000..b8037add --- /dev/null +++ b/src/api/types/VapiTranscriberTurnTaking.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the turn-taking mode. `intelligent` uses the underlying model's + * native end-of-turn detection; `manual` ignores it and waits a fixed + * end-of-turn delay. Defaults to `intelligent`. + */ +export const VapiTranscriberTurnTaking = { + Intelligent: "intelligent", + Manual: "manual", +} as const; +export type VapiTranscriberTurnTaking = (typeof VapiTranscriberTurnTaking)[keyof typeof VapiTranscriberTurnTaking]; diff --git a/src/api/types/VapiTranscriberVersion.ts b/src/api/types/VapiTranscriberVersion.ts new file mode 100644 index 00000000..2dbdf3b0 --- /dev/null +++ b/src/api/types/VapiTranscriberVersion.ts @@ -0,0 +1,14 @@ +// This file was auto-generated by Fern from our API Definition. + +/** + * This is the version of the Vapi transcriber. Vapi manages the underlying + * model and routing. When omitted, the latest version is used. + * + * Managed version params are additive-only and `'latest'` is an auto-update + * channel — see the param-evolution INVARIANT in `vapiManaged/types.ts`. + */ +export const VapiTranscriberVersion = { + Latest: "latest", + One: "1", +} as const; +export type VapiTranscriberVersion = (typeof VapiTranscriberVersion)[keyof typeof VapiTranscriberVersion]; diff --git a/src/api/types/VapiVoice.ts b/src/api/types/VapiVoice.ts index 3da0134b..9cb4db49 100644 --- a/src/api/types/VapiVoice.ts +++ b/src/api/types/VapiVoice.ts @@ -2,21 +2,26 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, caching, and fallback settings. + */ export interface VapiVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; - /** The voices provided by Vapi */ - voiceId: Vapi.VapiVoiceVoiceId; + /** The voice to use: a built-in Vapi voice name, or a cloned voice id (used with version 2). */ + voiceId: string; + /** The Vapi voice routing generation. `latest` auto-updates to the newest generation; version 1 uses legacy mappings; version 2 can use xAI-backed voices when available. When omitted, Version 1 is used. Accepts the string channel ('latest', '1', '2'); legacy numeric values (1, 2) are also accepted and coerced to their string form. */ + version?: Vapi.VapiVoiceVersion | undefined; /** * This is the speed multiplier that will be used. * * @default 1 */ speed?: number | undefined; + /** Language for Vapi voice synthesis. For Version 2, omit this field or set `auto` for automatic language detection. Version 1 supports legacy Vapi language values. */ + language?: Vapi.VapiVoiceLanguage | undefined; /** List of pronunciation dictionary locators for custom word pronunciations. */ pronunciationDictionary?: Vapi.VapiPronunciationDictionaryLocator[] | undefined; /** This is the plan for chunking the model output before it is sent to the voice provider. */ chunkPlan?: Vapi.ChunkPlan | undefined; - /** This is the plan for voice provider fallbacks in the event that the primary voice provider fails. */ - fallbackPlan?: Vapi.FallbackPlan | undefined; } diff --git a/src/api/types/VapiVoiceCloneDto.ts b/src/api/types/VapiVoiceCloneDto.ts new file mode 100644 index 00000000..2961eb6b --- /dev/null +++ b/src/api/types/VapiVoiceCloneDto.ts @@ -0,0 +1,13 @@ +// This file was auto-generated by Fern from our API Definition. + +export interface VapiVoiceCloneDto { + /** Display name for the cloned voice. */ + name: string; + /** + * Optional language (ISO-639 / BCP-47). When omitted, xAI infers it from the + * reference audio. + */ + language?: string | undefined; + /** Reference audio to clone the voice from (up to 120 seconds). Supported formats: MP3, WAV, OGG/Opus, WebM, AAC, M4A, FLAC, WMA. */ + files: string[]; +} diff --git a/src/api/types/VapiVoiceLanguage.ts b/src/api/types/VapiVoiceLanguage.ts new file mode 100644 index 00000000..1d0e2464 --- /dev/null +++ b/src/api/types/VapiVoiceLanguage.ts @@ -0,0 +1,63 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Language for Vapi voice synthesis. For Version 2, omit this field or set `auto` for automatic language detection. Version 1 supports legacy Vapi language values. */ +export const VapiVoiceLanguage = { + EnUs: "en-US", + EnGb: "en-GB", + EnAu: "en-AU", + EnCa: "en-CA", + Ja: "ja", + Zh: "zh", + De: "de", + Hi: "hi", + FrFr: "fr-FR", + FrCa: "fr-CA", + Ko: "ko", + PtBr: "pt-BR", + PtPt: "pt-PT", + It: "it", + EsEs: "es-ES", + EsMx: "es-MX", + Id: "id", + Nl: "nl", + Tr: "tr", + Fil: "fil", + Pl: "pl", + Sv: "sv", + Bg: "bg", + Ro: "ro", + ArSa: "ar-SA", + ArAe: "ar-AE", + Cs: "cs", + El: "el", + Fi: "fi", + Hr: "hr", + Ms: "ms", + Sk: "sk", + Da: "da", + Ta: "ta", + Uk: "uk", + Ru: "ru", + Hu: "hu", + No: "no", + Vi: "vi", + Auto: "auto", + En: "en", + Ar: "ar", + ArEg: "ar-EG", + Bn: "bn", + Es: "es", + Fr: "fr", + Gu: "gu", + He: "he", + Ka: "ka", + Kn: "kn", + Ml: "ml", + Mr: "mr", + Pa: "pa", + Pt: "pt", + Te: "te", + Th: "th", + Tl: "tl", +} as const; +export type VapiVoiceLanguage = (typeof VapiVoiceLanguage)[keyof typeof VapiVoiceLanguage]; diff --git a/src/api/types/VapiVoiceVersion.ts b/src/api/types/VapiVoiceVersion.ts new file mode 100644 index 00000000..bbf8cab4 --- /dev/null +++ b/src/api/types/VapiVoiceVersion.ts @@ -0,0 +1,9 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The Vapi voice routing generation. `latest` auto-updates to the newest generation; version 1 uses legacy mappings; version 2 can use xAI-backed voices when available. When omitted, Version 1 is used. Accepts the string channel ('latest', '1', '2'); legacy numeric values (1, 2) are also accepted and coerced to their string form. */ +export const VapiVoiceVersion = { + One: "1", + Two: "2", + Latest: "latest", +} as const; +export type VapiVoiceVersion = (typeof VapiVoiceVersion)[keyof typeof VapiVoiceVersion]; diff --git a/src/api/types/VapiVoiceVoiceId.ts b/src/api/types/VapiVoiceVoiceId.ts deleted file mode 100644 index d748ad30..00000000 --- a/src/api/types/VapiVoiceVoiceId.ts +++ /dev/null @@ -1,36 +0,0 @@ -// This file was auto-generated by Fern from our API Definition. - -/** The voices provided by Vapi */ -export const VapiVoiceVoiceId = { - Clara: "Clara", - Godfrey: "Godfrey", - Layla: "Layla", - Sid: "Sid", - Gustavo: "Gustavo", - Elliot: "Elliot", - Kylie: "Kylie", - Rohan: "Rohan", - Lily: "Lily", - Savannah: "Savannah", - Hana: "Hana", - Neha: "Neha", - Cole: "Cole", - Harry: "Harry", - Paige: "Paige", - Spencer: "Spencer", - Nico: "Nico", - Kai: "Kai", - Emma: "Emma", - Sagar: "Sagar", - Neil: "Neil", - Naina: "Naina", - Leah: "Leah", - Tara: "Tara", - Jess: "Jess", - Leo: "Leo", - Dan: "Dan", - Mia: "Mia", - Zac: "Zac", - Zoe: "Zoe", -} as const; -export type VapiVoiceVoiceId = (typeof VapiVoiceVoiceId)[keyof typeof VapiVoiceVoiceId]; diff --git a/src/api/types/VapiVoicemailDetectionPlan.ts b/src/api/types/VapiVoicemailDetectionPlan.ts index e36604c3..9ca27d1c 100644 --- a/src/api/types/VapiVoicemailDetectionPlan.ts +++ b/src/api/types/VapiVoicemailDetectionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff. + */ export interface VapiVoicemailDetectionPlan { /** * This is the maximum duration from the start of the call that we will wait for a voicemail beep, before speaking our message diff --git a/src/api/types/VapiWebCallTransport.ts b/src/api/types/VapiWebCallTransport.ts new file mode 100644 index 00000000..34281139 --- /dev/null +++ b/src/api/types/VapiWebCallTransport.ts @@ -0,0 +1,20 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VapiWebCallTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.VapiWebCallTransportConversationType | undefined; + /** + * This determines whether the daily room will be deleted and all participants will be kicked once the user leaves the room. + * If set to `false`, the room will be kept alive even after the user leaves, allowing clients to reconnect to the same room. + * If set to `true`, the room will be deleted and reconnection will not be allowed. + * + * Defaults to `true`. + */ + roomDeleteOnUserLeaveEnabled?: boolean | undefined; + /** This is the URL of the web call. */ + callUrl?: string | undefined; + /** This is the SIP URI of the web call. */ + callSipUri?: string | undefined; +} diff --git a/src/api/types/VapiWebCallTransportConversationType.ts b/src/api/types/VapiWebCallTransportConversationType.ts new file mode 100644 index 00000000..d855ef5c --- /dev/null +++ b/src/api/types/VapiWebCallTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const VapiWebCallTransportConversationType = { + Voice: "voice", +} as const; +export type VapiWebCallTransportConversationType = + (typeof VapiWebCallTransportConversationType)[keyof typeof VapiWebCallTransportConversationType]; diff --git a/src/api/types/VapiWebsocketTransport.ts b/src/api/types/VapiWebsocketTransport.ts new file mode 100644 index 00000000..0f53f5ca --- /dev/null +++ b/src/api/types/VapiWebsocketTransport.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VapiWebsocketTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.VapiWebsocketTransportConversationType | undefined; + /** This is the audio format of the call. Defaults to 16KHz raw pcm_s16le */ + audioFormat?: Vapi.AudioFormat | undefined; +} diff --git a/src/api/types/VapiWebsocketTransportConversationType.ts b/src/api/types/VapiWebsocketTransportConversationType.ts new file mode 100644 index 00000000..c013b9fc --- /dev/null +++ b/src/api/types/VapiWebsocketTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const VapiWebsocketTransportConversationType = { + Voice: "voice", +} as const; +export type VapiWebsocketTransportConversationType = + (typeof VapiWebsocketTransportConversationType)[keyof typeof VapiWebsocketTransportConversationType]; diff --git a/src/api/types/VariableExtractionAlias.ts b/src/api/types/VariableExtractionAlias.ts index c78571ee..bbaa121c 100644 --- a/src/api/types/VariableExtractionAlias.ts +++ b/src/api/types/VariableExtractionAlias.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Defines an additional Liquid-based variable from values extracted during a call. + */ export interface VariableExtractionAlias { /** * This is the key of the variable. diff --git a/src/api/types/VariableExtractionPlan.ts b/src/api/types/VariableExtractionPlan.ts index c859c28c..c95c9f7d 100644 --- a/src/api/types/VariableExtractionPlan.ts +++ b/src/api/types/VariableExtractionPlan.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Defines structured variables to extract and optional aliases made available during and after a call. + */ export interface VariableExtractionPlan { /** * This is the schema to extract. diff --git a/src/api/types/VariableValueGroupBy.ts b/src/api/types/VariableValueGroupBy.ts index f03c5aa2..9cc96320 100644 --- a/src/api/types/VariableValueGroupBy.ts +++ b/src/api/types/VariableValueGroupBy.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Groups analytics results by a selected assistant variable-value key. + */ export interface VariableValueGroupBy { /** This is the key of the variable value to group by. */ key: string; diff --git a/src/api/types/VersionPinConflictResponseDto.ts b/src/api/types/VersionPinConflictResponseDto.ts new file mode 100644 index 00000000..15b1603a --- /dev/null +++ b/src/api/types/VersionPinConflictResponseDto.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VersionPinConflictResponseDto { + error: Vapi.VersionPinConflictResponseDtoError; + /** Human-readable reason the delete was rejected. */ + message: string; + /** Pins that block the delete. */ + pinnedBy: Vapi.VersionPinReference[]; +} diff --git a/src/api/types/VersionPinConflictResponseDtoError.ts b/src/api/types/VersionPinConflictResponseDtoError.ts new file mode 100644 index 00000000..9f7bbd34 --- /dev/null +++ b/src/api/types/VersionPinConflictResponseDtoError.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +export const VersionPinConflictResponseDtoError = { + VersionPinned: "version_pinned", +} as const; +export type VersionPinConflictResponseDtoError = + (typeof VersionPinConflictResponseDtoError)[keyof typeof VersionPinConflictResponseDtoError]; diff --git a/src/api/types/VersionPinReference.ts b/src/api/types/VersionPinReference.ts new file mode 100644 index 00000000..622af5fd --- /dev/null +++ b/src/api/types/VersionPinReference.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VersionPinReference { + /** Kind of source row the pin originates from. */ + sourceType: Vapi.VersionPinReferenceSourceType; + /** UUID of the source row (polymorphic, not FK-enforced). */ + sourceId: string; +} diff --git a/src/api/types/VersionPinReferenceSourceType.ts b/src/api/types/VersionPinReferenceSourceType.ts new file mode 100644 index 00000000..da317824 --- /dev/null +++ b/src/api/types/VersionPinReferenceSourceType.ts @@ -0,0 +1,10 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Kind of source row the pin originates from. */ +export const VersionPinReferenceSourceType = { + AssistantVersion: "assistant_version", + Squad: "squad", + ToolVersion: "tool_version", +} as const; +export type VersionPinReferenceSourceType = + (typeof VersionPinReferenceSourceType)[keyof typeof VersionPinReferenceSourceType]; diff --git a/src/api/types/VoiceCost.ts b/src/api/types/VoiceCost.ts index 8021d3b0..c2a75a94 100644 --- a/src/api/types/VoiceCost.ts +++ b/src/api/types/VoiceCost.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Voice-synthesis cost for a call, including voice, character usage, and amount. + */ export interface VoiceCost { /** * This is the voice that was used during the call. diff --git a/src/api/types/VoiceLibrary.ts b/src/api/types/VoiceLibrary.ts index ab25d1f4..f16a0333 100644 --- a/src/api/types/VoiceLibrary.ts +++ b/src/api/types/VoiceLibrary.ts @@ -43,4 +43,15 @@ export interface VoiceLibrary { createdAt: string; /** The ISO 8601 date-time string of when the voice library was last updated. */ updatedAt: string; + /** + * Whether this voice was cloned by the org from their own audio, as opposed + * to a seeded/preset voice. Drives the cloned filter and tag. Backed by a + * NOT NULL DEFAULT false column, so it is always present at read time. + */ + isCloned?: boolean | undefined; + /** + * The provider that produced the clone (e.g. 'xai'). The voice `provider` + * stays 'vapi'; this records the underlying backend. Unset for non-cloned voices. + */ + cloneBackend?: string | undefined; } diff --git a/src/api/types/VoiceLibraryVoiceResponse.ts b/src/api/types/VoiceLibraryVoiceResponse.ts index ead79bda..ce2ea26d 100644 --- a/src/api/types/VoiceLibraryVoiceResponse.ts +++ b/src/api/types/VoiceLibraryVoiceResponse.ts @@ -1,11 +1,13 @@ // This file was auto-generated by Fern from our API Definition. +import type * as Vapi from "../index.js"; + export interface VoiceLibraryVoiceResponse { + age?: Vapi.VoiceLibraryVoiceResponseAge | undefined; voiceId: string; name: string; publicOwnerId?: string | undefined; description?: string | undefined; gender?: string | undefined; - age?: Record | undefined; accent?: string | undefined; } diff --git a/src/api/types/VoiceLibraryVoiceResponseAge.ts b/src/api/types/VoiceLibraryVoiceResponseAge.ts new file mode 100644 index 00000000..945fd7ba --- /dev/null +++ b/src/api/types/VoiceLibraryVoiceResponseAge.ts @@ -0,0 +1,3 @@ +// This file was auto-generated by Fern from our API Definition. + +export type VoiceLibraryVoiceResponseAge = string | number; diff --git a/src/api/types/VoicemailDetectionBackoffPlan.ts b/src/api/types/VoicemailDetectionBackoffPlan.ts index 80858217..61bf9d69 100644 --- a/src/api/types/VoicemailDetectionBackoffPlan.ts +++ b/src/api/types/VoicemailDetectionBackoffPlan.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts. + */ export interface VoicemailDetectionBackoffPlan { /** This is the number of seconds to wait before starting the first retry attempt. */ startAtSeconds?: number | undefined; diff --git a/src/api/types/VoicemailDetectionCost.ts b/src/api/types/VoicemailDetectionCost.ts index 52aabc09..0acde3af 100644 --- a/src/api/types/VoicemailDetectionCost.ts +++ b/src/api/types/VoicemailDetectionCost.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Voicemail-detection model cost, including provider, model, multimodal token usage, and amount. + */ export interface VoicemailDetectionCost { /** This is the model that was used to perform the analysis. */ model: Record; diff --git a/src/api/types/VoicemailTool.ts b/src/api/types/VoicemailTool.ts index 9ecbc7dd..6106422e 100644 --- a/src/api/types/VoicemailTool.ts +++ b/src/api/types/VoicemailTool.ts @@ -2,12 +2,12 @@ import type * as Vapi from "../index.js"; +/** + * A reusable voicemail-detection tool with optional beep detection for supported calls. + */ export interface VoicemailTool { - /** - * 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. - */ + latestVersion?: (string | null) | undefined; + /** Messages spoken while the tool is running. Multiple request-start messages are variants. For request-response-delayed, same timing means variants and different timings mean staged updates. */ messages?: Vapi.VoicemailToolMessagesItem[] | undefined; /** * This is the flag that enables beep detection for voicemail detection and applies only for twilio based calls. diff --git a/src/api/types/VonagePhoneNumber.ts b/src/api/types/VonagePhoneNumber.ts index c555996f..77cea813 100644 --- a/src/api/types/VonagePhoneNumber.ts +++ b/src/api/types/VonagePhoneNumber.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ export interface VonagePhoneNumber { /** * This is the fallback destination an inbound call will be transferred to if: diff --git a/src/api/types/VonageTransport.ts b/src/api/types/VonageTransport.ts new file mode 100644 index 00000000..af2cba38 --- /dev/null +++ b/src/api/types/VonageTransport.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface VonageTransport { + /** This is the conversation type of the call (ie, voice or chat). */ + conversationType?: Vapi.VonageTransportConversationType | undefined; + /** This is the conversation UUID of the Vonage call. */ + conversationUUID?: string | undefined; + /** This is the call ID of the Vonage call. */ + callUUID?: string | undefined; +} diff --git a/src/api/types/VonageTransportConversationType.ts b/src/api/types/VonageTransportConversationType.ts new file mode 100644 index 00000000..ef481b35 --- /dev/null +++ b/src/api/types/VonageTransportConversationType.ts @@ -0,0 +1,8 @@ +// This file was auto-generated by Fern from our API Definition. + +/** This is the conversation type of the call (ie, voice or chat). */ +export const VonageTransportConversationType = { + Voice: "voice", +} as const; +export type VonageTransportConversationType = + (typeof VonageTransportConversationType)[keyof typeof VonageTransportConversationType]; diff --git a/src/api/types/WellSaidVoice.ts b/src/api/types/WellSaidVoice.ts index 45a584d4..6421a743 100644 --- a/src/api/types/WellSaidVoice.ts +++ b/src/api/types/WellSaidVoice.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, caching, and fallback settings. + */ export interface WellSaidVoice { /** This is the flag to toggle voice caching for the assistant. */ cachingEnabled?: boolean | undefined; diff --git a/src/api/types/WorkflowAnthropicBedrockModel.ts b/src/api/types/WorkflowAnthropicBedrockModel.ts index 592c0f45..1dc67654 100644 --- a/src/api/types/WorkflowAnthropicBedrockModel.ts +++ b/src/api/types/WorkflowAnthropicBedrockModel.ts @@ -2,7 +2,23 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, temperature, and maximum output tokens. + */ export interface WorkflowAnthropicBedrockModel { + /** + * These are the messages used to customize the prompt used for structured output extraction. + * + * When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: + * - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) + * - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) + * - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` + * + * `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. + * + * If not provided, default system and user prompts are used. + */ + messages?: Vapi.OpenAiMessage[] | undefined; /** This is the specific model that will be used. */ model: Vapi.WorkflowAnthropicBedrockModelModel; /** diff --git a/src/api/types/WorkflowAnthropicBedrockModelModel.ts b/src/api/types/WorkflowAnthropicBedrockModelModel.ts index daadeb82..30e2175f 100644 --- a/src/api/types/WorkflowAnthropicBedrockModelModel.ts +++ b/src/api/types/WorkflowAnthropicBedrockModelModel.ts @@ -16,6 +16,7 @@ export const WorkflowAnthropicBedrockModelModel = { ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929", ClaudeSonnet46: "claude-sonnet-4-6", ClaudeHaiku4520251001: "claude-haiku-4-5-20251001", + GlobalAnthropicClaudeHaiku4520251001V10: "global.anthropic.claude-haiku-4-5-20251001-v1:0", } as const; export type WorkflowAnthropicBedrockModelModel = (typeof WorkflowAnthropicBedrockModelModel)[keyof typeof WorkflowAnthropicBedrockModelModel]; diff --git a/src/api/types/WorkflowAnthropicModel.ts b/src/api/types/WorkflowAnthropicModel.ts index 6f4437f2..d5183027 100644 --- a/src/api/types/WorkflowAnthropicModel.ts +++ b/src/api/types/WorkflowAnthropicModel.ts @@ -2,7 +2,23 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output tokens. + */ export interface WorkflowAnthropicModel { + /** + * These are the messages used to customize the prompt used for structured output extraction. + * + * When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: + * - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) + * - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) + * - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` + * + * `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. + * + * If not provided, default system and user prompts are used. + */ + messages?: Vapi.OpenAiMessage[] | undefined; /** This is the specific model that will be used. */ model: Vapi.WorkflowAnthropicModelModel; /** diff --git a/src/api/types/WorkflowAnthropicModelModel.ts b/src/api/types/WorkflowAnthropicModelModel.ts index 3da7b29e..f37f78cf 100644 --- a/src/api/types/WorkflowAnthropicModelModel.ts +++ b/src/api/types/WorkflowAnthropicModelModel.ts @@ -15,6 +15,7 @@ export const WorkflowAnthropicModelModel = { ClaudeSonnet420250514: "claude-sonnet-4-20250514", ClaudeSonnet4520250929: "claude-sonnet-4-5-20250929", ClaudeSonnet46: "claude-sonnet-4-6", + ClaudeSonnet5: "claude-sonnet-5", ClaudeHaiku4520251001: "claude-haiku-4-5-20251001", } as const; export type WorkflowAnthropicModelModel = diff --git a/src/api/types/WorkflowCredentialsItem.ts b/src/api/types/WorkflowCredentialsItem.ts index a8a29f17..442de489 100644 --- a/src/api/types/WorkflowCredentialsItem.ts +++ b/src/api/types/WorkflowCredentialsItem.ts @@ -34,6 +34,7 @@ export type WorkflowCredentialsItem = | Vapi.WorkflowCredentialsItem.RimeAi | Vapi.WorkflowCredentialsItem.Runpod | Vapi.WorkflowCredentialsItem.S3 + | Vapi.WorkflowCredentialsItem.S3Compatible | Vapi.WorkflowCredentialsItem.Supabase | Vapi.WorkflowCredentialsItem.SmallestAi | Vapi.WorkflowCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type WorkflowCredentialsItem = | Vapi.WorkflowCredentialsItem.Webhook | Vapi.WorkflowCredentialsItem.CustomCredential | Vapi.WorkflowCredentialsItem.Xai + | Vapi.WorkflowCredentialsItem.Microsoft | Vapi.WorkflowCredentialsItem.Neuphonic | Vapi.WorkflowCredentialsItem.Hume | Vapi.WorkflowCredentialsItem.Mistral | Vapi.WorkflowCredentialsItem.Speechmatics | Vapi.WorkflowCredentialsItem.Soniox - | Vapi.WorkflowCredentialsItem.Trieve | Vapi.WorkflowCredentialsItem.GoogleCalendarOauth2Client | Vapi.WorkflowCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.WorkflowCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace WorkflowCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace WorkflowCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace WorkflowCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace WorkflowCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.WorkflowCredentialsItem._11Labs + | Vapi.WorkflowCredentialsItem.Anthropic + | Vapi.WorkflowCredentialsItem.AnthropicBedrock + | Vapi.WorkflowCredentialsItem.Anyscale + | Vapi.WorkflowCredentialsItem.AssemblyAi + | Vapi.WorkflowCredentialsItem.AzureOpenai + | Vapi.WorkflowCredentialsItem.Azure + | Vapi.WorkflowCredentialsItem.ByoSipTrunk + | Vapi.WorkflowCredentialsItem.Cartesia + | Vapi.WorkflowCredentialsItem.Cerebras + | Vapi.WorkflowCredentialsItem.Cloudflare + | Vapi.WorkflowCredentialsItem.CustomLlm + | Vapi.WorkflowCredentialsItem.Deepgram + | Vapi.WorkflowCredentialsItem.Deepinfra + | Vapi.WorkflowCredentialsItem.DeepSeek + | Vapi.WorkflowCredentialsItem.Gcp + | Vapi.WorkflowCredentialsItem.Gladia + | Vapi.WorkflowCredentialsItem.Gohighlevel + | Vapi.WorkflowCredentialsItem.Google + | Vapi.WorkflowCredentialsItem.Groq + | Vapi.WorkflowCredentialsItem.InflectionAi + | Vapi.WorkflowCredentialsItem.Langfuse + | Vapi.WorkflowCredentialsItem.Lmnt + | Vapi.WorkflowCredentialsItem.Make + | Vapi.WorkflowCredentialsItem.Openai + | Vapi.WorkflowCredentialsItem.Openrouter + | Vapi.WorkflowCredentialsItem.PerplexityAi + | Vapi.WorkflowCredentialsItem.Playht + | Vapi.WorkflowCredentialsItem.RimeAi + | Vapi.WorkflowCredentialsItem.Runpod + | Vapi.WorkflowCredentialsItem.S3 + | Vapi.WorkflowCredentialsItem.S3Compatible + | Vapi.WorkflowCredentialsItem.Supabase + | Vapi.WorkflowCredentialsItem.SmallestAi + | Vapi.WorkflowCredentialsItem.Tavus + | Vapi.WorkflowCredentialsItem.TogetherAi + | Vapi.WorkflowCredentialsItem.Twilio + | Vapi.WorkflowCredentialsItem.Vonage + | Vapi.WorkflowCredentialsItem.Webhook + | Vapi.WorkflowCredentialsItem.CustomCredential + | Vapi.WorkflowCredentialsItem.Xai + | Vapi.WorkflowCredentialsItem.Microsoft + | Vapi.WorkflowCredentialsItem.Neuphonic + | Vapi.WorkflowCredentialsItem.Hume + | Vapi.WorkflowCredentialsItem.Mistral + | Vapi.WorkflowCredentialsItem.Speechmatics + | Vapi.WorkflowCredentialsItem.Soniox + | Vapi.WorkflowCredentialsItem.GoogleCalendarOauth2Client + | Vapi.WorkflowCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.WorkflowCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.WorkflowCredentialsItem.SlackOauth2Authorization + | Vapi.WorkflowCredentialsItem.GhlOauth2Authorization + | Vapi.WorkflowCredentialsItem.Inworld + | Vapi.WorkflowCredentialsItem.Minimax + | Vapi.WorkflowCredentialsItem.Wellsaid + | Vapi.WorkflowCredentialsItem.Email + | Vapi.WorkflowCredentialsItem.SlackWebhook; } diff --git a/src/api/types/WorkflowCustomModel.ts b/src/api/types/WorkflowCustomModel.ts index 7daaf2c9..05634a34 100644 --- a/src/api/types/WorkflowCustomModel.ts +++ b/src/api/types/WorkflowCustomModel.ts @@ -2,7 +2,23 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, timeout, model, temperature, and maximum output tokens. + */ export interface WorkflowCustomModel { + /** + * These are the messages used to customize the prompt used for structured output extraction. + * + * When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: + * - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) + * - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) + * - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` + * + * `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. + * + * If not provided, default system and user prompts are used. + */ + messages?: Vapi.OpenAiMessage[] | undefined; /** * This determines whether metadata is sent in requests to the custom provider. * diff --git a/src/api/types/WorkflowGoogleModel.ts b/src/api/types/WorkflowGoogleModel.ts index dccd5350..eaabc302 100644 --- a/src/api/types/WorkflowGoogleModel.ts +++ b/src/api/types/WorkflowGoogleModel.ts @@ -2,7 +2,23 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for Google, including model selection, temperature, and maximum output tokens. + */ export interface WorkflowGoogleModel { + /** + * These are the messages used to customize the prompt used for structured output extraction. + * + * When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: + * - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) + * - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) + * - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` + * + * `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. + * + * If not provided, default system and user prompts are used. + */ + messages?: Vapi.OpenAiMessage[] | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.WorkflowGoogleModelModel; /** This is the temperature of the model. */ diff --git a/src/api/types/WorkflowGoogleModelModel.ts b/src/api/types/WorkflowGoogleModelModel.ts index 2ecb6202..faa55aaa 100644 --- a/src/api/types/WorkflowGoogleModelModel.ts +++ b/src/api/types/WorkflowGoogleModelModel.ts @@ -2,6 +2,8 @@ /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ export const WorkflowGoogleModelModel = { + Gemini35Flash: "gemini-3.5-flash", + Gemini31FlashLite: "gemini-3.1-flash-lite", Gemini3FlashPreview: "gemini-3-flash-preview", Gemini25Pro: "gemini-2.5-pro", Gemini25Flash: "gemini-2.5-flash", diff --git a/src/api/types/WorkflowNodesItem.ts b/src/api/types/WorkflowNodesItem.ts index e6b332be..cf5ac90d 100644 --- a/src/api/types/WorkflowNodesItem.ts +++ b/src/api/types/WorkflowNodesItem.ts @@ -12,4 +12,6 @@ export namespace WorkflowNodesItem { export interface Tool extends Vapi.ToolNode { type: "tool"; } + + export type Response = Vapi.WorkflowNodesItem.Conversation | Vapi.WorkflowNodesItem.Tool; } diff --git a/src/api/types/WorkflowOpenAiModel.ts b/src/api/types/WorkflowOpenAiModel.ts index e7c46422..c0797a8a 100644 --- a/src/api/types/WorkflowOpenAiModel.ts +++ b/src/api/types/WorkflowOpenAiModel.ts @@ -2,7 +2,23 @@ import type * as Vapi from "../index.js"; +/** + * Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens. + */ export interface WorkflowOpenAiModel { + /** + * These are the messages used to customize the prompt used for structured output extraction. + * + * When provided, these messages replace the default prompts. Message contents support LiquidJS templating with the following variables: + * - `{{transcript}}` or `{{messages}}` to reference the conversation (one is required) + * - `{{structuredOutput.name}}`, `{{structuredOutput.description}}`, or `{{structuredOutput.schema}}` to reference the structured output definition (one is required) + * - `{{systemPrompt}}`, `{{callEndedReason}}`, `{{duration}}`, `{{startedAt}}`, `{{endedAt}}`, and any `assistantOverrides.variableValues` + * + * `{{messages}}` is the full message history including tool calls; `{{transcript}}` is the spoken text only, which uses significantly fewer tokens. + * + * If not provided, default system and user prompts are used. + */ + messages?: Vapi.OpenAiMessage[] | undefined; /** * This is the OpenAI model that will be used. * diff --git a/src/api/types/WorkflowOpenAiModelModel.ts b/src/api/types/WorkflowOpenAiModelModel.ts index abd88af1..cec65636 100644 --- a/src/api/types/WorkflowOpenAiModelModel.ts +++ b/src/api/types/WorkflowOpenAiModelModel.ts @@ -7,6 +7,11 @@ * This is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/. */ export const WorkflowOpenAiModelModel = { + Gpt56Sol: "gpt-5.6-sol", + Gpt56Terra: "gpt-5.6-terra", + Gpt56Luna: "gpt-5.6-luna", + Gpt55: "gpt-5.5", + ChatLatest: "chat-latest", Gpt54: "gpt-5.4", Gpt54Mini: "gpt-5.4-mini", Gpt54Nano: "gpt-5.4-nano", @@ -48,6 +53,35 @@ export const WorkflowOpenAiModelModel = { Gpt35Turbo1106: "gpt-3.5-turbo-1106", Gpt35Turbo16K: "gpt-3.5-turbo-16k", Gpt35Turbo0613: "gpt-3.5-turbo-0613", + Gpt56LunaWestus3: "gpt-5.6-luna:westus3", + Gpt56TerraWestus3: "gpt-5.6-terra:westus3", + Gpt56SolWestus3: "gpt-5.6-sol:westus3", + Gpt54Eastus2: "gpt-5.4:eastus2", + Gpt54Swedencentral: "gpt-5.4:swedencentral", + Gpt54MiniEastus2: "gpt-5.4-mini:eastus2", + Gpt54MiniSwedencentral: "gpt-5.4-mini:swedencentral", + Gpt54NanoEastus2: "gpt-5.4-nano:eastus2", + Gpt54NanoSwedencentral: "gpt-5.4-nano:swedencentral", + Gpt52Eastus2: "gpt-5.2:eastus2", + Gpt52Swedencentral: "gpt-5.2:swedencentral", + Gpt51Eastus2: "gpt-5.1:eastus2", + Gpt51Swedencentral: "gpt-5.1:swedencentral", + Gpt5Eastus2: "gpt-5:eastus2", + Gpt5Swedencentral: "gpt-5:swedencentral", + Gpt5Canadaeast: "gpt-5:canadaeast", + Gpt5Eastus: "gpt-5:eastus", + Gpt5Westeurope: "gpt-5:westeurope", + Gpt5Germanywestcentral: "gpt-5:germanywestcentral", + Gpt5Polandcentral: "gpt-5:polandcentral", + Gpt5Spaincentral: "gpt-5:spaincentral", + Gpt5MiniEastus2: "gpt-5-mini:eastus2", + Gpt5MiniSwedencentral: "gpt-5-mini:swedencentral", + Gpt5MiniWesteurope: "gpt-5-mini:westeurope", + Gpt5MiniGermanywestcentral: "gpt-5-mini:germanywestcentral", + Gpt5MiniPolandcentral: "gpt-5-mini:polandcentral", + Gpt5MiniSpaincentral: "gpt-5-mini:spaincentral", + Gpt5NanoEastus2: "gpt-5-nano:eastus2", + Gpt5NanoSwedencentral: "gpt-5-nano:swedencentral", Gpt4120250414Westus: "gpt-4.1-2025-04-14:westus", Gpt4120250414Eastus2: "gpt-4.1-2025-04-14:eastus2", Gpt4120250414Eastus: "gpt-4.1-2025-04-14:eastus", @@ -120,5 +154,8 @@ export const WorkflowOpenAiModelModel = { Gpt35Turbo0125Southcentralus: "gpt-3.5-turbo-0125:southcentralus", Gpt35Turbo1106Canadaeast: "gpt-3.5-turbo-1106:canadaeast", Gpt35Turbo1106Westus: "gpt-3.5-turbo-1106:westus", + Gpt41Australiaeast: "gpt-4.1:australiaeast", + Gpt4OAustraliaeast: "gpt-4o:australiaeast", + Gpt54MiniAustraliaeast: "gpt-5.4-mini:australiaeast", } as const; export type WorkflowOpenAiModelModel = (typeof WorkflowOpenAiModelModel)[keyof typeof WorkflowOpenAiModelModel]; diff --git a/src/api/types/WorkflowOverrides.ts b/src/api/types/WorkflowOverrides.ts index c627b7b5..2f335ca3 100644 --- a/src/api/types/WorkflowOverrides.ts +++ b/src/api/types/WorkflowOverrides.ts @@ -1,5 +1,8 @@ // This file was auto-generated by Fern from our API Definition. +/** + * Per-call overrides for values used in workflow template variables. + */ export interface WorkflowOverrides { /** * These are values that will be used to replace the template variables in the workflow messages and other text-based fields. diff --git a/src/api/types/WorkflowTranscriber.ts b/src/api/types/WorkflowTranscriber.ts index 2cff4540..749eadaf 100644 --- a/src/api/types/WorkflowTranscriber.ts +++ b/src/api/types/WorkflowTranscriber.ts @@ -19,7 +19,9 @@ export type WorkflowTranscriber = | Vapi.WorkflowTranscriber.Talkscriber | Vapi.WorkflowTranscriber.Openai | Vapi.WorkflowTranscriber.Cartesia - | Vapi.WorkflowTranscriber.Soniox; + | Vapi.WorkflowTranscriber.Soniox + | Vapi.WorkflowTranscriber.Xai + | Vapi.WorkflowTranscriber.Vapi; export namespace WorkflowTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -69,4 +71,12 @@ export namespace WorkflowTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/WorkflowUserEditableCredentialsItem.ts b/src/api/types/WorkflowUserEditableCredentialsItem.ts index 99d3ed7d..a24318f3 100644 --- a/src/api/types/WorkflowUserEditableCredentialsItem.ts +++ b/src/api/types/WorkflowUserEditableCredentialsItem.ts @@ -34,6 +34,7 @@ export type WorkflowUserEditableCredentialsItem = | Vapi.WorkflowUserEditableCredentialsItem.RimeAi | Vapi.WorkflowUserEditableCredentialsItem.Runpod | Vapi.WorkflowUserEditableCredentialsItem.S3 + | Vapi.WorkflowUserEditableCredentialsItem.S3Compatible | Vapi.WorkflowUserEditableCredentialsItem.Supabase | Vapi.WorkflowUserEditableCredentialsItem.SmallestAi | Vapi.WorkflowUserEditableCredentialsItem.Tavus @@ -43,12 +44,12 @@ export type WorkflowUserEditableCredentialsItem = | Vapi.WorkflowUserEditableCredentialsItem.Webhook | Vapi.WorkflowUserEditableCredentialsItem.CustomCredential | Vapi.WorkflowUserEditableCredentialsItem.Xai + | Vapi.WorkflowUserEditableCredentialsItem.Microsoft | Vapi.WorkflowUserEditableCredentialsItem.Neuphonic | Vapi.WorkflowUserEditableCredentialsItem.Hume | Vapi.WorkflowUserEditableCredentialsItem.Mistral | Vapi.WorkflowUserEditableCredentialsItem.Speechmatics | Vapi.WorkflowUserEditableCredentialsItem.Soniox - | Vapi.WorkflowUserEditableCredentialsItem.Trieve | Vapi.WorkflowUserEditableCredentialsItem.GoogleCalendarOauth2Client | Vapi.WorkflowUserEditableCredentialsItem.GoogleCalendarOauth2Authorization | Vapi.WorkflowUserEditableCredentialsItem.GoogleSheetsOauth2Authorization @@ -185,6 +186,10 @@ export namespace WorkflowUserEditableCredentialsItem { provider: "s3"; } + export interface S3Compatible extends Vapi.CreateS3CompatibleCredentialDto { + provider: "s3-compatible"; + } + export interface Supabase extends Vapi.CreateSupabaseCredentialDto { provider: "supabase"; } @@ -221,6 +226,10 @@ export namespace WorkflowUserEditableCredentialsItem { provider: "xai"; } + export interface Microsoft extends Vapi.CreateMicrosoftCredentialDto { + provider: "microsoft"; + } + export interface Neuphonic extends Vapi.CreateNeuphonicCredentialDto { provider: "neuphonic"; } @@ -241,10 +250,6 @@ export namespace WorkflowUserEditableCredentialsItem { provider: "soniox"; } - export interface Trieve extends Vapi.CreateTrieveCredentialDto { - provider: "trieve"; - } - export interface GoogleCalendarOauth2Client extends Vapi.CreateGoogleCalendarOAuth2ClientCredentialDto { provider: "google.calendar.oauth2-client"; } @@ -285,4 +290,63 @@ export namespace WorkflowUserEditableCredentialsItem { export interface SlackWebhook extends Vapi.CreateSlackWebhookCredentialDto { provider: "slack-webhook"; } + + export type Response = + | Vapi.WorkflowUserEditableCredentialsItem._11Labs + | Vapi.WorkflowUserEditableCredentialsItem.Anthropic + | Vapi.WorkflowUserEditableCredentialsItem.AnthropicBedrock + | Vapi.WorkflowUserEditableCredentialsItem.Anyscale + | Vapi.WorkflowUserEditableCredentialsItem.AssemblyAi + | Vapi.WorkflowUserEditableCredentialsItem.AzureOpenai + | Vapi.WorkflowUserEditableCredentialsItem.Azure + | Vapi.WorkflowUserEditableCredentialsItem.ByoSipTrunk + | Vapi.WorkflowUserEditableCredentialsItem.Cartesia + | Vapi.WorkflowUserEditableCredentialsItem.Cerebras + | Vapi.WorkflowUserEditableCredentialsItem.Cloudflare + | Vapi.WorkflowUserEditableCredentialsItem.CustomLlm + | Vapi.WorkflowUserEditableCredentialsItem.Deepgram + | Vapi.WorkflowUserEditableCredentialsItem.Deepinfra + | Vapi.WorkflowUserEditableCredentialsItem.DeepSeek + | Vapi.WorkflowUserEditableCredentialsItem.Gcp + | Vapi.WorkflowUserEditableCredentialsItem.Gladia + | Vapi.WorkflowUserEditableCredentialsItem.Gohighlevel + | Vapi.WorkflowUserEditableCredentialsItem.Google + | Vapi.WorkflowUserEditableCredentialsItem.Groq + | Vapi.WorkflowUserEditableCredentialsItem.InflectionAi + | Vapi.WorkflowUserEditableCredentialsItem.Langfuse + | Vapi.WorkflowUserEditableCredentialsItem.Lmnt + | Vapi.WorkflowUserEditableCredentialsItem.Make + | Vapi.WorkflowUserEditableCredentialsItem.Openai + | Vapi.WorkflowUserEditableCredentialsItem.Openrouter + | Vapi.WorkflowUserEditableCredentialsItem.PerplexityAi + | Vapi.WorkflowUserEditableCredentialsItem.Playht + | Vapi.WorkflowUserEditableCredentialsItem.RimeAi + | Vapi.WorkflowUserEditableCredentialsItem.Runpod + | Vapi.WorkflowUserEditableCredentialsItem.S3 + | Vapi.WorkflowUserEditableCredentialsItem.S3Compatible + | Vapi.WorkflowUserEditableCredentialsItem.Supabase + | Vapi.WorkflowUserEditableCredentialsItem.SmallestAi + | Vapi.WorkflowUserEditableCredentialsItem.Tavus + | Vapi.WorkflowUserEditableCredentialsItem.TogetherAi + | Vapi.WorkflowUserEditableCredentialsItem.Twilio + | Vapi.WorkflowUserEditableCredentialsItem.Vonage + | Vapi.WorkflowUserEditableCredentialsItem.Webhook + | Vapi.WorkflowUserEditableCredentialsItem.CustomCredential + | Vapi.WorkflowUserEditableCredentialsItem.Xai + | Vapi.WorkflowUserEditableCredentialsItem.Microsoft + | Vapi.WorkflowUserEditableCredentialsItem.Neuphonic + | Vapi.WorkflowUserEditableCredentialsItem.Hume + | Vapi.WorkflowUserEditableCredentialsItem.Mistral + | Vapi.WorkflowUserEditableCredentialsItem.Speechmatics + | Vapi.WorkflowUserEditableCredentialsItem.Soniox + | Vapi.WorkflowUserEditableCredentialsItem.GoogleCalendarOauth2Client + | Vapi.WorkflowUserEditableCredentialsItem.GoogleCalendarOauth2Authorization + | Vapi.WorkflowUserEditableCredentialsItem.GoogleSheetsOauth2Authorization + | Vapi.WorkflowUserEditableCredentialsItem.SlackOauth2Authorization + | Vapi.WorkflowUserEditableCredentialsItem.GhlOauth2Authorization + | Vapi.WorkflowUserEditableCredentialsItem.Inworld + | Vapi.WorkflowUserEditableCredentialsItem.Minimax + | Vapi.WorkflowUserEditableCredentialsItem.Wellsaid + | Vapi.WorkflowUserEditableCredentialsItem.Email + | Vapi.WorkflowUserEditableCredentialsItem.SlackWebhook; } diff --git a/src/api/types/WorkflowUserEditableNodesItem.ts b/src/api/types/WorkflowUserEditableNodesItem.ts index 122727b9..3639a96b 100644 --- a/src/api/types/WorkflowUserEditableNodesItem.ts +++ b/src/api/types/WorkflowUserEditableNodesItem.ts @@ -14,4 +14,6 @@ export namespace WorkflowUserEditableNodesItem { export interface Tool extends Vapi.ToolNode { type: "tool"; } + + export type Response = Vapi.WorkflowUserEditableNodesItem.Conversation | Vapi.WorkflowUserEditableNodesItem.Tool; } diff --git a/src/api/types/WorkflowUserEditableTranscriber.ts b/src/api/types/WorkflowUserEditableTranscriber.ts index 3d336113..62d92f2e 100644 --- a/src/api/types/WorkflowUserEditableTranscriber.ts +++ b/src/api/types/WorkflowUserEditableTranscriber.ts @@ -19,7 +19,9 @@ export type WorkflowUserEditableTranscriber = | Vapi.WorkflowUserEditableTranscriber.Talkscriber | Vapi.WorkflowUserEditableTranscriber.Openai | Vapi.WorkflowUserEditableTranscriber.Cartesia - | Vapi.WorkflowUserEditableTranscriber.Soniox; + | Vapi.WorkflowUserEditableTranscriber.Soniox + | Vapi.WorkflowUserEditableTranscriber.Xai + | Vapi.WorkflowUserEditableTranscriber.Vapi; export namespace WorkflowUserEditableTranscriber { export interface AssemblyAi extends Vapi.AssemblyAiTranscriber { @@ -69,4 +71,12 @@ export namespace WorkflowUserEditableTranscriber { export interface Soniox extends Vapi.SonioxTranscriber { provider: "soniox"; } + + export interface Xai extends Vapi.XaiTranscriber { + provider: "xai"; + } + + export interface Vapi extends Vapi.VapiTranscriber { + provider: "vapi"; + } } diff --git a/src/api/types/WorkflowUserEditableVoice.ts b/src/api/types/WorkflowUserEditableVoice.ts index a878d990..2f2d21e7 100644 --- a/src/api/types/WorkflowUserEditableVoice.ts +++ b/src/api/types/WorkflowUserEditableVoice.ts @@ -25,7 +25,9 @@ export type WorkflowUserEditableVoice = | Vapi.WorkflowUserEditableVoice.Vapi | Vapi.WorkflowUserEditableVoice.Sesame | Vapi.WorkflowUserEditableVoice.Inworld - | Vapi.WorkflowUserEditableVoice.Minimax; + | Vapi.WorkflowUserEditableVoice.Minimax + | Vapi.WorkflowUserEditableVoice.Xai + | Vapi.WorkflowUserEditableVoice.Microsoft; export namespace WorkflowUserEditableVoice { export interface Azure extends Vapi.AzureVoice { @@ -99,4 +101,12 @@ export namespace WorkflowUserEditableVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/WorkflowVoice.ts b/src/api/types/WorkflowVoice.ts index eac93529..5a818ca6 100644 --- a/src/api/types/WorkflowVoice.ts +++ b/src/api/types/WorkflowVoice.ts @@ -25,7 +25,9 @@ export type WorkflowVoice = | Vapi.WorkflowVoice.Vapi | Vapi.WorkflowVoice.Sesame | Vapi.WorkflowVoice.Inworld - | Vapi.WorkflowVoice.Minimax; + | Vapi.WorkflowVoice.Minimax + | Vapi.WorkflowVoice.Xai + | Vapi.WorkflowVoice.Microsoft; export namespace WorkflowVoice { export interface Azure extends Vapi.AzureVoice { @@ -99,4 +101,12 @@ export namespace WorkflowVoice { export interface Minimax extends Vapi.MinimaxVoice { provider: "minimax"; } + + export interface Xai extends Vapi.XaiVoice { + provider: "xai"; + } + + export interface Microsoft extends Vapi.MicrosoftVoice { + provider: "microsoft"; + } } diff --git a/src/api/types/XaiModel.ts b/src/api/types/XaiModel.ts index 0b11639f..1d142b49 100644 --- a/src/api/types/XaiModel.ts +++ b/src/api/types/XaiModel.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, and generation settings. + */ export interface XaiModel { /** This is the starting state for the conversation. */ messages?: Vapi.OpenAiMessage[] | undefined; @@ -17,11 +20,18 @@ export interface XaiModel { * Both `tools` and `toolIds` can be used together. */ toolIds?: string[] | undefined; + /** + * These are version-pinned references to tools. Each entry pins a specific + * version of a tool by `(toolId, version)`. When the same `toolId` appears + * in both `toolIds` and `toolRefs[]`, the `toolRefs` pin wins (the + * `toolIds` entry is dropped at write time). + */ + toolRefs?: Vapi.ToolRef[] | undefined; /** These are the options for the knowledge base. */ knowledgeBase?: Vapi.CreateCustomKnowledgeBaseDto | undefined; /** This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b */ model: Vapi.XaiModelModel; - /** This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency. */ + /** This is the temperature that will be used for calls. Default is 0.5. */ temperature?: number | undefined; /** This is the max number of tokens that the assistant will be allowed to generate in each turn of the conversation. Default is 250. */ maxTokens?: number | undefined; diff --git a/src/api/types/XaiModelModel.ts b/src/api/types/XaiModelModel.ts index 0d01bc3e..15965314 100644 --- a/src/api/types/XaiModelModel.ts +++ b/src/api/types/XaiModelModel.ts @@ -7,5 +7,8 @@ export const XaiModelModel = { Grok3: "grok-3", Grok4FastReasoning: "grok-4-fast-reasoning", Grok4FastNonReasoning: "grok-4-fast-non-reasoning", + Grok4200309Reasoning: "grok-4.20-0309-reasoning", + Grok4200309NonReasoning: "grok-4.20-0309-non-reasoning", + Grok43: "grok-4.3", } as const; export type XaiModelModel = (typeof XaiModelModel)[keyof typeof XaiModelModel]; diff --git a/src/api/types/XaiModelToolsItem.ts b/src/api/types/XaiModelToolsItem.ts index 532a2825..c2be3c3f 100644 --- a/src/api/types/XaiModelToolsItem.ts +++ b/src/api/types/XaiModelToolsItem.ts @@ -119,4 +119,29 @@ export namespace XaiModelToolsItem { export interface Voicemail extends Vapi.CreateVoicemailToolDto { type: "voicemail"; } + + export type Response = + | Vapi.XaiModelToolsItem.ApiRequest + | Vapi.XaiModelToolsItem.Bash + | Vapi.XaiModelToolsItem.Code + | Vapi.XaiModelToolsItem.Computer + | Vapi.XaiModelToolsItem.Dtmf + | Vapi.XaiModelToolsItem.EndCall + | Vapi.XaiModelToolsItem.Function + | Vapi.XaiModelToolsItem.GohighlevelCalendarAvailabilityCheck + | Vapi.XaiModelToolsItem.GohighlevelCalendarEventCreate + | Vapi.XaiModelToolsItem.GohighlevelContactCreate + | Vapi.XaiModelToolsItem.GohighlevelContactGet + | Vapi.XaiModelToolsItem.GoogleCalendarAvailabilityCheck + | Vapi.XaiModelToolsItem.GoogleCalendarEventCreate + | Vapi.XaiModelToolsItem.GoogleSheetsRowAppend + | Vapi.XaiModelToolsItem.Handoff + | Vapi.XaiModelToolsItem.Mcp + | Vapi.XaiModelToolsItem.Query + | Vapi.XaiModelToolsItem.SlackMessageSend + | Vapi.XaiModelToolsItem.Sms + | Vapi.XaiModelToolsItem.TextEditor + | Vapi.XaiModelToolsItem.TransferCall + | Vapi.XaiModelToolsItem.SipRequest + | Vapi.XaiModelToolsItem.Voicemail; } diff --git a/src/api/types/XaiTranscriber.ts b/src/api/types/XaiTranscriber.ts new file mode 100644 index 00000000..d9f1b828 --- /dev/null +++ b/src/api/types/XaiTranscriber.ts @@ -0,0 +1,12 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface XaiTranscriber { + /** The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection. */ + model?: Vapi.XaiTranscriberModel | undefined; + /** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). Defaults to `en` if not set. xAI auto-detects when omitted via the API but Vapi defaults to English for deterministic behavior. */ + language?: Vapi.XaiTranscriberLanguage | undefined; + /** This is the plan for transcriber provider fallbacks in the event that the primary transcriber provider fails. */ + fallbackPlan?: Vapi.FallbackTranscriberPlan | undefined; +} diff --git a/src/api/types/XaiTranscriberLanguage.ts b/src/api/types/XaiTranscriberLanguage.ts new file mode 100644 index 00000000..fd839391 --- /dev/null +++ b/src/api/types/XaiTranscriberLanguage.ts @@ -0,0 +1,31 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Single language for transcription as an ISO 639-1 code (e.g., `en`, `es`). Defaults to `en` if not set. xAI auto-detects when omitted via the API but Vapi defaults to English for deterministic behavior. */ +export const XaiTranscriberLanguage = { + Ar: "ar", + Cs: "cs", + Da: "da", + Nl: "nl", + En: "en", + Fil: "fil", + Fr: "fr", + De: "de", + Hi: "hi", + Id: "id", + It: "it", + Ja: "ja", + Ko: "ko", + Mk: "mk", + Ms: "ms", + Fa: "fa", + Pl: "pl", + Pt: "pt", + Ro: "ro", + Ru: "ru", + Es: "es", + Sv: "sv", + Th: "th", + Tr: "tr", + Vi: "vi", +} as const; +export type XaiTranscriberLanguage = (typeof XaiTranscriberLanguage)[keyof typeof XaiTranscriberLanguage]; diff --git a/src/api/types/XaiTranscriberModel.ts b/src/api/types/XaiTranscriberModel.ts new file mode 100644 index 00000000..557b2d94 --- /dev/null +++ b/src/api/types/XaiTranscriberModel.ts @@ -0,0 +1,7 @@ +// This file was auto-generated by Fern from our API Definition. + +/** The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection. */ +export const XaiTranscriberModel = { + Default: "default", +} as const; +export type XaiTranscriberModel = (typeof XaiTranscriberModel)[keyof typeof XaiTranscriberModel]; diff --git a/src/api/types/XaiVoice.ts b/src/api/types/XaiVoice.ts new file mode 100644 index 00000000..a52208a7 --- /dev/null +++ b/src/api/types/XaiVoice.ts @@ -0,0 +1,18 @@ +// This file was auto-generated by Fern from our API Definition. + +import type * as Vapi from "../index.js"; + +export interface XaiVoice { + /** This is the flag to toggle voice caching for the assistant. */ + cachingEnabled?: boolean | undefined; + /** Built-in voices: eve, ara, rex, sal, leo. Cloned voice IDs are also accepted. */ + voiceId: Vapi.XaiVoiceVoiceId; + /** BCP-47 language code for xAI TTS synthesis. */ + language?: Vapi.XaiVoiceLanguage | undefined; + /** Speed multiplier for xAI TTS synthesis. */ + speed?: number | undefined; + /** This is the plan for chunking the model output before it is sent to the voice provider. */ + chunkPlan?: Vapi.ChunkPlan | undefined; + /** This is the plan for voice provider fallbacks in the event that the primary voice provider fails. */ + fallbackPlan?: Vapi.FallbackPlan | undefined; +} diff --git a/src/api/types/XaiVoiceLanguage.ts b/src/api/types/XaiVoiceLanguage.ts new file mode 100644 index 00000000..add5fffe --- /dev/null +++ b/src/api/types/XaiVoiceLanguage.ts @@ -0,0 +1,27 @@ +// This file was auto-generated by Fern from our API Definition. + +/** BCP-47 language code for xAI TTS synthesis. */ +export const XaiVoiceLanguage = { + Auto: "auto", + En: "en", + ArEg: "ar-EG", + ArSa: "ar-SA", + ArAe: "ar-AE", + Bn: "bn", + Zh: "zh", + Fr: "fr", + De: "de", + Hi: "hi", + Id: "id", + It: "it", + Ja: "ja", + Ko: "ko", + PtBr: "pt-BR", + PtPt: "pt-PT", + Ru: "ru", + EsMx: "es-MX", + EsEs: "es-ES", + Tr: "tr", + Vi: "vi", +} as const; +export type XaiVoiceLanguage = (typeof XaiVoiceLanguage)[keyof typeof XaiVoiceLanguage]; diff --git a/src/api/types/XaiVoiceVoiceId.ts b/src/api/types/XaiVoiceVoiceId.ts new file mode 100644 index 00000000..631f7df3 --- /dev/null +++ b/src/api/types/XaiVoiceVoiceId.ts @@ -0,0 +1,11 @@ +// This file was auto-generated by Fern from our API Definition. + +/** Built-in voices: eve, ara, rex, sal, leo. Cloned voice IDs are also accepted. */ +export const XaiVoiceVoiceId = { + Eve: "eve", + Ara: "ara", + Rex: "rex", + Sal: "sal", + Leo: "leo", +} as const; +export type XaiVoiceVoiceId = (typeof XaiVoiceVoiceId)[keyof typeof XaiVoiceVoiceId]; diff --git a/src/api/types/XssSecurityFilter.ts b/src/api/types/XssSecurityFilter.ts index 4e98e6bb..374b1013 100644 --- a/src/api/types/XssSecurityFilter.ts +++ b/src/api/types/XssSecurityFilter.ts @@ -2,6 +2,9 @@ import type * as Vapi from "../index.js"; +/** + * Filters potential cross-site scripting (XSS) patterns from transcripts. + */ export interface XssSecurityFilter { /** The type of security threat to filter. */ type: Vapi.XssSecurityFilterType; diff --git a/src/api/types/index.ts b/src/api/types/index.ts index fb683f94..4309a668 100644 --- a/src/api/types/index.ts +++ b/src/api/types/index.ts @@ -42,6 +42,8 @@ export * from "./AssemblyAiCredential.js"; export * from "./AssemblyAiCredentialProvider.js"; export * from "./AssemblyAiTranscriber.js"; export * from "./AssemblyAiTranscriberLanguage.js"; +export * from "./AssemblyAiTranscriberLanguageCodesItem.js"; +export * from "./AssemblyAiTranscriberMode.js"; export * from "./AssemblyAiTranscriberSpeechModel.js"; export * from "./Assistant.js"; export * from "./AssistantActivation.js"; @@ -50,6 +52,22 @@ export * from "./AssistantBackgroundSoundZero.js"; export * from "./AssistantClientMessagesItem.js"; export * from "./AssistantCredentialsItem.js"; export * from "./AssistantCustomEndpointingRule.js"; +export * from "./AssistantDraft.js"; +export * from "./AssistantDraftBackgroundSound.js"; +export * from "./AssistantDraftBackgroundSoundZero.js"; +export * from "./AssistantDraftClientMessagesItem.js"; +export * from "./AssistantDraftConflictResponseDto.js"; +export * from "./AssistantDraftCredentialsItem.js"; +export * from "./AssistantDraftFirstMessageMode.js"; +export * from "./AssistantDraftHooksItem.js"; +export * from "./AssistantDraftModel.js"; +export * from "./AssistantDraftPaginatedMetadata.js"; +export * from "./AssistantDraftPaginatedResponse.js"; +export * from "./AssistantDraftServerMessagesItem.js"; +export * from "./AssistantDraftTranscriber.js"; +export * from "./AssistantDraftVoice.js"; +export * from "./AssistantDraftVoicemailDetection.js"; +export * from "./AssistantDraftVoicemailDetectionZero.js"; export * from "./AssistantFirstMessageMode.js"; export * from "./AssistantHookAssistantSpeechInterrupted.js"; export * from "./AssistantHookCallEnding.js"; @@ -79,16 +97,34 @@ export * from "./AssistantOverridesVoice.js"; export * from "./AssistantOverridesVoicemailDetection.js"; export * from "./AssistantOverridesVoicemailDetectionZero.js"; export * from "./AssistantPaginatedResponse.js"; +export * from "./AssistantPinnedConflictResponseDto.js"; +export * from "./AssistantPinnedConflictResponseDtoError.js"; export * from "./AssistantServerMessagesItem.js"; export * from "./AssistantSpeechWordAlignmentTiming.js"; export * from "./AssistantSpeechWordProgressTiming.js"; export * from "./AssistantSpeechWordTimestamp.js"; export * from "./AssistantTranscriber.js"; export * from "./AssistantUserEditable.js"; +export * from "./AssistantVersion.js"; +export * from "./AssistantVersionBackgroundSound.js"; +export * from "./AssistantVersionBackgroundSoundZero.js"; +export * from "./AssistantVersionClientMessagesItem.js"; +export * from "./AssistantVersionCredentialsItem.js"; +export * from "./AssistantVersionFirstMessageMode.js"; +export * from "./AssistantVersionHooksItem.js"; +export * from "./AssistantVersionModel.js"; +export * from "./AssistantVersionPaginatedMetadata.js"; export * from "./AssistantVersionPaginatedResponse.js"; +export * from "./AssistantVersionServerMessagesItem.js"; +export * from "./AssistantVersionTranscriber.js"; +export * from "./AssistantVersionVoice.js"; +export * from "./AssistantVersionVoicemailDetection.js"; +export * from "./AssistantVersionVoicemailDetectionZero.js"; export * from "./AssistantVoice.js"; export * from "./AssistantVoicemailDetection.js"; export * from "./AssistantVoicemailDetectionZero.js"; +export * from "./AudioFormat.js"; +export * from "./AudioFormatContainer.js"; export * from "./AutoReloadPlan.js"; export * from "./AwsiamCredentialsAuthenticationPlan.js"; export * from "./AwsStsAssumeRoleUser.js"; @@ -130,6 +166,19 @@ export * from "./BashToolWithToolCallMessagesItem.js"; export * from "./BashToolWithToolCallName.js"; export * from "./BashToolWithToolCallSubType.js"; export * from "./BearerAuthenticationPlan.js"; +export * from "./Board.js"; +export * from "./BoardInsightItem.js"; +export * from "./BoardInsightItemType.js"; +export * from "./BoardItemPosition.js"; +export * from "./BoardItemSize.js"; +export * from "./BoardItemsItem.js"; +export * from "./BoardLayout.js"; +export * from "./BoardMetricWidgetItem.js"; +export * from "./BoardMetricWidgetItemType.js"; +export * from "./BoardPaginatedResponse.js"; +export * from "./BooleanComparatorScorecardMetricCondition.js"; +export * from "./BooleanComparatorScorecardMetricConditionComparator.js"; +export * from "./BooleanComparatorScorecardMetricConditionType.js"; export * from "./BothCustomEndpointingRule.js"; export * from "./BotMessage.js"; export * from "./BucketPlan.js"; @@ -140,6 +189,8 @@ export * from "./ByoPhoneNumberStatus.js"; export * from "./ByoSipTrunkCredential.js"; export * from "./ByoSipTrunkCredentialProvider.js"; export * from "./Call.js"; +export * from "./CallArtifactUploadItem.js"; +export * from "./CallArtifactUploadItemType.js"; export * from "./CallBatchError.js"; export * from "./CallBatchResponse.js"; export * from "./CallCostsItem.js"; @@ -168,11 +219,25 @@ export * from "./CallPaginatedResponse.js"; export * from "./CallPhoneCallProvider.js"; export * from "./CallPhoneCallTransport.js"; export * from "./CallStatus.js"; +export * from "./CallTransport.js"; export * from "./CallType.js"; export * from "./Campaign.js"; +export * from "./CampaignCallMetrics.js"; +export * from "./CampaignContact.js"; +export * from "./CampaignContactCounters.js"; +export * from "./CampaignContactPaginatedResponse.js"; +export * from "./CampaignContactWithOutcome.js"; +export * from "./CampaignContactWithOutcomeStatus.js"; export * from "./CampaignEndedReason.js"; export * from "./CampaignPaginatedResponse.js"; +export * from "./CampaignPredialPlan.js"; +export * from "./CampaignServerMessagesItem.js"; export * from "./CampaignStatus.js"; +export * from "./CampaignSummary.js"; +export * from "./CampaignSummaryEndedReason.js"; +export * from "./CampaignSummaryPaginatedResponse.js"; +export * from "./CampaignSummaryServerMessagesItem.js"; +export * from "./CampaignSummaryStatus.js"; export * from "./CartesiaCredential.js"; export * from "./CartesiaCredentialProvider.js"; export * from "./CartesiaExperimentalControls.js"; @@ -330,6 +395,7 @@ export * from "./ConditionOperator.js"; export * from "./ContextEngineeringPlanAll.js"; export * from "./ContextEngineeringPlanLastNMessages.js"; export * from "./ContextEngineeringPlanNone.js"; +export * from "./ContextEngineeringPlanPreviousAssistantMessages.js"; export * from "./ContextEngineeringPlanUserAndAssistantMessages.js"; export * from "./ConversationNode.js"; export * from "./ConversationNodeModel.js"; @@ -346,6 +412,19 @@ export * from "./CreateApiRequestToolDto.js"; export * from "./CreateApiRequestToolDtoMessagesItem.js"; export * from "./CreateApiRequestToolDtoMethod.js"; export * from "./CreateAssemblyAiCredentialDto.js"; +export * from "./CreateAssistantDraftDto.js"; +export * from "./CreateAssistantDraftDtoBackgroundSound.js"; +export * from "./CreateAssistantDraftDtoBackgroundSoundZero.js"; +export * from "./CreateAssistantDraftDtoClientMessagesItem.js"; +export * from "./CreateAssistantDraftDtoCredentialsItem.js"; +export * from "./CreateAssistantDraftDtoFirstMessageMode.js"; +export * from "./CreateAssistantDraftDtoHooksItem.js"; +export * from "./CreateAssistantDraftDtoModel.js"; +export * from "./CreateAssistantDraftDtoServerMessagesItem.js"; +export * from "./CreateAssistantDraftDtoTranscriber.js"; +export * from "./CreateAssistantDraftDtoVoice.js"; +export * from "./CreateAssistantDraftDtoVoicemailDetection.js"; +export * from "./CreateAssistantDraftDtoVoicemailDetectionZero.js"; export * from "./CreateAssistantDto.js"; export * from "./CreateAssistantDtoBackgroundSound.js"; export * from "./CreateAssistantDtoBackgroundSoundZero.js"; @@ -376,6 +455,8 @@ export * from "./CreateByoPhoneNumberDto.js"; export * from "./CreateByoPhoneNumberDtoFallbackDestination.js"; export * from "./CreateByoPhoneNumberDtoHooksItem.js"; export * from "./CreateByoSipTrunkCredentialDto.js"; +export * from "./CreateCampaignDto.js"; +export * from "./CreateCampaignDtoServerMessagesItem.js"; export * from "./CreateCartesiaCredentialDto.js"; export * from "./CreateCerebrasCredentialDto.js"; export * from "./CreateChatStreamResponse.js"; @@ -399,6 +480,7 @@ export * from "./CreateDeepSeekCredentialDto.js"; export * from "./CreateDtmfToolDto.js"; export * from "./CreateDtmfToolDtoMessagesItem.js"; export * from "./CreateElevenLabsCredentialDto.js"; +export * from "./CreateElevenLabsCredentialDtoApiUrl.js"; export * from "./CreateEmailCredentialDto.js"; export * from "./CreateEndCallToolDto.js"; export * from "./CreateEndCallToolDtoMessagesItem.js"; @@ -450,6 +532,7 @@ export * from "./CreateMakeToolDtoMessagesItem.js"; export * from "./CreateMakeToolDtoType.js"; export * from "./CreateMcpToolDto.js"; export * from "./CreateMcpToolDtoMessagesItem.js"; +export * from "./CreateMicrosoftCredentialDto.js"; export * from "./CreateMinimaxCredentialDto.js"; export * from "./CreateMistralCredentialDto.js"; export * from "./CreateNeuphonicCredentialDto.js"; @@ -458,6 +541,7 @@ export * from "./CreateOpenRouterCredentialDto.js"; export * from "./CreateOrgDto.js"; export * from "./CreateOrgDtoChannel.js"; export * from "./CreateOutboundCallDto.js"; +export * from "./CreateOutboundCallDtoTransport.js"; export * from "./CreateOutputToolDto.js"; export * from "./CreateOutputToolDtoMessagesItem.js"; export * from "./CreateOutputToolDtoType.js"; @@ -471,16 +555,16 @@ export * from "./CreateQueryToolDto.js"; export * from "./CreateQueryToolDtoMessagesItem.js"; export * from "./CreateRimeAiCredentialDto.js"; export * from "./CreateRunpodCredentialDto.js"; +export * from "./CreateS3CompatibleCredentialDto.js"; export * from "./CreateS3CredentialDto.js"; export * from "./CreateScenarioDto.js"; export * from "./CreateScenarioDtoHooksItem.js"; export * from "./CreateScorecardDto.js"; export * from "./CreateSesameVoiceDto.js"; -export * from "./CreateSimulationDto.js"; -export * from "./CreateSimulationRunDto.js"; -export * from "./CreateSimulationRunDtoSimulationsItem.js"; -export * from "./CreateSimulationRunDtoTarget.js"; -export * from "./CreateSimulationSuiteDto.js"; +export * from "./CreateSimulationRunResponse.js"; +export * from "./CreateSimulationRunResponseSimulationsItem.js"; +export * from "./CreateSimulationRunResponseStatus.js"; +export * from "./CreateSimulationRunResponseTarget.js"; export * from "./CreateSipRequestToolDto.js"; export * from "./CreateSipRequestToolDtoBody.js"; export * from "./CreateSipRequestToolDtoMessagesItem.js"; @@ -496,6 +580,7 @@ export * from "./CreateSonioxCredentialDto.js"; export * from "./CreateSpeechmaticsCredentialDto.js"; export * from "./CreateSquadDto.js"; export * from "./CreateStructuredOutputDto.js"; +export * from "./CreateStructuredOutputDtoConditionsItem.js"; export * from "./CreateStructuredOutputDtoModel.js"; export * from "./CreateStructuredOutputDtoType.js"; export * from "./CreateSupabaseCredentialDto.js"; @@ -518,6 +603,11 @@ export * from "./CreateTextInsightFromCallTableDtoQueriesItem.js"; export * from "./CreateTogetherAiCredentialDto.js"; export * from "./CreateTokenDto.js"; export * from "./CreateTokenDtoTag.js"; +export * from "./CreateToolDraftDto.js"; +export * from "./CreateToolDraftDtoMessagesItem.js"; +export * from "./CreateToolDraftDtoMethod.js"; +export * from "./CreateToolDraftDtoType.js"; +export * from "./CreateToolDraftDtoVerb.js"; export * from "./CreateToolTemplateDto.js"; export * from "./CreateToolTemplateDtoDetails.js"; export * from "./CreateToolTemplateDtoProvider.js"; @@ -529,7 +619,6 @@ export * from "./CreateTransferCallToolDtoDestinationsItem.js"; export * from "./CreateTransferCallToolDtoMessagesItem.js"; export * from "./CreateTrieveCredentialDto.js"; export * from "./CreateTrieveKnowledgeBaseDto.js"; -export * from "./CreateTrieveKnowledgeBaseDtoProvider.js"; export * from "./CreateTwilioCredentialDto.js"; export * from "./CreateTwilioPhoneNumberDto.js"; export * from "./CreateTwilioPhoneNumberDtoFallbackDestination.js"; @@ -579,6 +668,7 @@ export * from "./CustomEndpointingModelSmartEndpointingPlan.js"; export * from "./CustomEndpointingModelSmartEndpointingPlanProvider.js"; export * from "./CustomerCustomEndpointingRule.js"; export * from "./CustomerSpeechTimeoutOptions.js"; +export * from "./CustomerSpeechTimeoutOptionsTriggerResetMode.js"; export * from "./CustomKnowledgeBase.js"; export * from "./CustomKnowledgeBaseProvider.js"; export * from "./CustomLlmCredential.js"; @@ -595,6 +685,7 @@ export * from "./DeepgramCredentialProvider.js"; export * from "./DeepgramTranscriber.js"; export * from "./DeepgramTranscriberLanguage.js"; export * from "./DeepgramTranscriberModel.js"; +export * from "./DeepgramTranscriberRedactionItem.js"; export * from "./DeepgramVoice.js"; export * from "./DeepgramVoiceId.js"; export * from "./DeepgramVoiceModel.js"; @@ -614,6 +705,7 @@ export * from "./DtmfTool.js"; export * from "./DtmfToolMessagesItem.js"; export * from "./Edge.js"; export * from "./ElevenLabsCredential.js"; +export * from "./ElevenLabsCredentialApiUrl.js"; export * from "./ElevenLabsPronunciationDictionary.js"; export * from "./ElevenLabsPronunciationDictionaryLocator.js"; export * from "./ElevenLabsPronunciationDictionaryPermissionOnResource.js"; @@ -628,6 +720,8 @@ export * from "./EmailCredential.js"; export * from "./EmailCredentialProvider.js"; export * from "./EndCallTool.js"; export * from "./EndCallToolMessagesItem.js"; +export * from "./EndedReasonCondition.js"; +export * from "./EndedReasonConditionOperator.js"; export * from "./EndpointedSpeechLowConfidenceOptions.js"; export * from "./Eval.js"; export * from "./EvalAnthropicModel.js"; @@ -672,14 +766,18 @@ export * from "./ExactReplacement.js"; export * from "./ExportChatDto.js"; export * from "./ExportChatDtoColumns.js"; export * from "./ExportChatDtoFormat.js"; +export * from "./ExportChatDtoSortBy.js"; export * from "./ExportChatDtoSortOrder.js"; export * from "./ExportSessionDto.js"; export * from "./ExportSessionDtoColumns.js"; export * from "./ExportSessionDtoFormat.js"; +export * from "./ExportSessionDtoSortBy.js"; export * from "./ExportSessionDtoSortOrder.js"; export * from "./FailedEdgeCondition.js"; export * from "./FallbackAssemblyAiTranscriber.js"; export * from "./FallbackAssemblyAiTranscriberLanguage.js"; +export * from "./FallbackAssemblyAiTranscriberLanguageCodesItem.js"; +export * from "./FallbackAssemblyAiTranscriberMode.js"; export * from "./FallbackAssemblyAiTranscriberSpeechModel.js"; export * from "./FallbackAzureSpeechTranscriber.js"; export * from "./FallbackAzureSpeechTranscriberLanguage.js"; @@ -698,6 +796,7 @@ export * from "./FallbackCustomVoice.js"; export * from "./FallbackDeepgramTranscriber.js"; export * from "./FallbackDeepgramTranscriberLanguage.js"; export * from "./FallbackDeepgramTranscriberModel.js"; +export * from "./FallbackDeepgramTranscriberRedactionItem.js"; export * from "./FallbackDeepgramVoice.js"; export * from "./FallbackDeepgramVoiceId.js"; export * from "./FallbackDeepgramVoiceModel.js"; @@ -711,7 +810,7 @@ export * from "./FallbackElevenLabsVoiceModel.js"; export * from "./FallbackGladiaTranscriber.js"; export * from "./FallbackGladiaTranscriberLanguage.js"; export * from "./FallbackGladiaTranscriberLanguageBehaviour.js"; -export * from "./FallbackGladiaTranscriberLanguages.js"; +export * from "./FallbackGladiaTranscriberLanguagesItem.js"; export * from "./FallbackGladiaTranscriberModel.js"; export * from "./FallbackGladiaTranscriberRegion.js"; export * from "./FallbackGoogleTranscriber.js"; @@ -727,6 +826,10 @@ export * from "./FallbackLmntVoice.js"; export * from "./FallbackLmntVoiceId.js"; export * from "./FallbackLmntVoiceIdEnum.js"; export * from "./FallbackLmntVoiceLanguage.js"; +export * from "./FallbackMicrosoftVoice.js"; +export * from "./FallbackMicrosoftVoiceRole.js"; +export * from "./FallbackMicrosoftVoiceStyle.js"; +export * from "./FallbackMicrosoftVoiceVoiceId.js"; export * from "./FallbackMinimaxVoice.js"; export * from "./FallbackMinimaxVoiceLanguageBoost.js"; export * from "./FallbackMinimaxVoiceModel.js"; @@ -764,6 +867,7 @@ export * from "./FallbackSmallestAiVoiceIdEnum.js"; export * from "./FallbackSmallestAiVoiceModel.js"; export * from "./FallbackSonioxTranscriber.js"; export * from "./FallbackSonioxTranscriberLanguage.js"; +export * from "./FallbackSonioxTranscriberLanguagesItem.js"; export * from "./FallbackSonioxTranscriberModel.js"; export * from "./FallbackSpeechmaticsTranscriber.js"; export * from "./FallbackSpeechmaticsTranscriberLanguage.js"; @@ -780,9 +884,16 @@ export * from "./FallbackTavusVoiceVoiceIdZero.js"; export * from "./FallbackTranscriberPlan.js"; export * from "./FallbackTranscriberPlanTranscribersItem.js"; export * from "./FallbackVapiVoice.js"; -export * from "./FallbackVapiVoiceVoiceId.js"; +export * from "./FallbackVapiVoiceLanguage.js"; +export * from "./FallbackVapiVoiceVersion.js"; export * from "./FallbackWellSaidVoice.js"; export * from "./FallbackWellSaidVoiceModel.js"; +export * from "./FallbackXaiTranscriber.js"; +export * from "./FallbackXaiTranscriberLanguage.js"; +export * from "./FallbackXaiTranscriberModel.js"; +export * from "./FallbackXaiVoice.js"; +export * from "./FallbackXaiVoiceLanguage.js"; +export * from "./FallbackXaiVoiceVoiceId.js"; export * from "./File_.js"; export * from "./FileObject.js"; export * from "./FileStatus.js"; @@ -827,16 +938,20 @@ export * from "./GeminiMultimodalLiveSpeechConfig.js"; export * from "./GeminiMultimodalLiveVoiceConfig.js"; export * from "./GeneratedScenario.js"; export * from "./GeneratedScenarioCategory.js"; -export * from "./GenerateScenariosDto.js"; export * from "./GenerateScenariosResponse.js"; export * from "./GetChatPaginatedDto.js"; +export * from "./GetChatPaginatedDtoSortBy.js"; export * from "./GetChatPaginatedDtoSortOrder.js"; export * from "./GetEvalPaginatedDto.js"; +export * from "./GetEvalPaginatedDtoSortBy.js"; export * from "./GetEvalPaginatedDtoSortOrder.js"; export * from "./GetEvalRunPaginatedDto.js"; +export * from "./GetEvalRunPaginatedDtoSortBy.js"; export * from "./GetEvalRunPaginatedDtoSortOrder.js"; export * from "./GetSessionPaginatedDto.js"; +export * from "./GetSessionPaginatedDtoSortBy.js"; export * from "./GetSessionPaginatedDtoSortOrder.js"; +export * from "./GetToolDraftsDto.js"; export * from "./GhlTool.js"; export * from "./GhlToolMessagesItem.js"; export * from "./GhlToolMetadata.js"; @@ -851,7 +966,7 @@ export * from "./GladiaCustomVocabularyConfigDtoVocabularyItem.js"; export * from "./GladiaTranscriber.js"; export * from "./GladiaTranscriberLanguage.js"; export * from "./GladiaTranscriberLanguageBehaviour.js"; -export * from "./GladiaTranscriberLanguages.js"; +export * from "./GladiaTranscriberLanguagesItem.js"; export * from "./GladiaTranscriberModel.js"; export * from "./GladiaTranscriberRegion.js"; export * from "./GladiaVocabularyItemDto.js"; @@ -964,6 +1079,7 @@ export * from "./InsightTimeRangeWithStepStep.js"; export * from "./InsightType.js"; export * from "./InviteUserDto.js"; export * from "./InviteUserDtoRole.js"; +export * from "./InviteUserDtoRoleZero.js"; export * from "./InvoicePlan.js"; export * from "./InworldCredential.js"; export * from "./InworldCredentialProvider.js"; @@ -1006,11 +1122,20 @@ export * from "./KnowledgeBaseCost.js"; export * from "./KnowledgeBaseModel.js"; export * from "./KnowledgeBaseProvider.js"; export * from "./KnowledgeBaseResponseDocument.js"; +export * from "./KnowledgeBaseTool.js"; +export * from "./KnowledgeBaseToolFunction.js"; +export * from "./KnowledgeBaseToolMessagesItem.js"; +export * from "./KnowledgeBaseV2.js"; +export * from "./KnowledgeBaseV2File.js"; +export * from "./KnowledgeBaseV2FileStatus.js"; +export * from "./KnowledgeBaseV2WithFiles.js"; export * from "./LangfuseCredential.js"; export * from "./LangfuseCredentialProvider.js"; export * from "./LangfuseObservabilityPlan.js"; export * from "./LangfuseObservabilityPlanProvider.js"; export * from "./LatencyMetrics.js"; +export * from "./LegacyAssistantVersion.js"; +export * from "./LegacyAssistantVersionPaginatedResponse.js"; export * from "./LineInsight.js"; export * from "./LineInsightFromCallTable.js"; export * from "./LineInsightFromCallTableGroupBy.js"; @@ -1047,6 +1172,13 @@ export * from "./McpToolMetadataProtocol.js"; export * from "./MessageAddHookAction.js"; export * from "./MessageTarget.js"; export * from "./MessageTargetRole.js"; +export * from "./MicrosoftCredential.js"; +export * from "./MicrosoftCredentialProvider.js"; +export * from "./MicrosoftVoice.js"; +export * from "./MicrosoftVoiceRole.js"; +export * from "./MicrosoftVoiceStyle.js"; +export * from "./MicrosoftVoiceVoiceId.js"; +export * from "./MinCallDurationCondition.js"; export * from "./MinimaxLlmModel.js"; export * from "./MinimaxLlmModelModel.js"; export * from "./MinimaxLlmModelToolsItem.js"; @@ -1055,6 +1187,7 @@ export * from "./MinimaxVoiceLanguageBoost.js"; export * from "./MinimaxVoiceModel.js"; export * from "./MinimaxVoiceRegion.js"; export * from "./MinimaxVoiceSubtitleType.js"; +export * from "./MinMessagesCondition.js"; export * from "./MistralCredential.js"; export * from "./MistralCredentialProvider.js"; export * from "./ModelCost.js"; @@ -1069,6 +1202,9 @@ export * from "./NeuphonicVoice.js"; export * from "./NeuphonicVoiceModel.js"; export * from "./NodeArtifact.js"; export * from "./NodeArtifactMessagesItem.js"; +export * from "./NumberComparatorScorecardMetricCondition.js"; +export * from "./NumberComparatorScorecardMetricConditionComparator.js"; +export * from "./NumberComparatorScorecardMetricConditionType.js"; export * from "./OAuth2AuthenticationPlan.js"; export * from "./OAuth2AuthenticationPlanType.js"; export * from "./Oauth2AuthenticationSession.js"; @@ -1083,6 +1219,7 @@ export * from "./OpenAiModel.js"; export * from "./OpenAiModelFallbackModelsItem.js"; export * from "./OpenAiModelModel.js"; export * from "./OpenAiModelPromptCacheRetention.js"; +export * from "./OpenAiModelReasoningEffort.js"; export * from "./OpenAiModelToolStrictCompatibilityMode.js"; export * from "./OpenAiModelToolsItem.js"; export * from "./OpenAiTranscriber.js"; @@ -1108,6 +1245,9 @@ export * from "./OutputTool.js"; export * from "./OutputToolMessagesItem.js"; export * from "./OutputToolType.js"; export * from "./PaginationMeta.js"; +export * from "./PaginationMetaSortOrder.js"; +export * from "./PendingInvitationDto.js"; +export * from "./PendingInvitationsResponseDto.js"; export * from "./PerformanceMetrics.js"; export * from "./PerplexityAiCredential.js"; export * from "./PerplexityAiCredentialProvider.js"; @@ -1159,9 +1299,12 @@ export * from "./RceSecurityFilterType.js"; export * from "./Recording.js"; export * from "./RecordingConsent.js"; export * from "./RecordingConsentPlanStayOnLine.js"; +export * from "./RecordingConsentPlanStayOnLineFirstMessageMode.js"; export * from "./RecordingConsentPlanStayOnLineVoice.js"; export * from "./RecordingConsentPlanVerbal.js"; +export * from "./RecordingConsentPlanVerbalFirstMessageMode.js"; export * from "./RecordingConsentPlanVerbalVoice.js"; +export * from "./RecordingConsentType.js"; export * from "./RegexCondition.js"; export * from "./RegexOption.js"; export * from "./RegexOptionType.js"; @@ -1198,6 +1341,7 @@ export * from "./ResponseTextDeltaEvent.js"; export * from "./ResponseTextDeltaEventType.js"; export * from "./ResponseTextDoneEvent.js"; export * from "./ResponseTextDoneEventType.js"; +export * from "./RevokeInvitationResponseDto.js"; export * from "./RimeAiCredential.js"; export * from "./RimeAiCredentialProvider.js"; export * from "./RimeAiVoice.js"; @@ -1207,10 +1351,14 @@ export * from "./RimeAiVoiceLanguage.js"; export * from "./RimeAiVoiceModel.js"; export * from "./RunpodCredential.js"; export * from "./RunpodCredentialProvider.js"; +export * from "./S3CompatibleBucketPlan.js"; +export * from "./S3CompatibleStorageCredential.js"; +export * from "./S3CompatibleStorageCredentialProvider.js"; export * from "./S3Credential.js"; export * from "./S3CredentialProvider.js"; export * from "./SayAssistantHookAction.js"; export * from "./SayHookAction.js"; +export * from "./SayHookActionExact.js"; export * from "./SayHookActionPrompt.js"; export * from "./SayHookActionPromptOneItem.js"; export * from "./SayPhoneNumberHookAction.js"; @@ -1221,6 +1369,7 @@ export * from "./ScenarioToolMock.js"; export * from "./SchedulePlan.js"; export * from "./Scorecard.js"; export * from "./ScorecardMetric.js"; +export * from "./ScorecardMetricConditionsItem.js"; export * from "./ScorecardPaginatedResponse.js"; export * from "./SecurityFilterBase.js"; export * from "./SecurityFilterPlan.js"; @@ -1235,6 +1384,9 @@ export * from "./ServerMessageAssistantSpeechPhoneNumber.js"; export * from "./ServerMessageAssistantSpeechSource.js"; export * from "./ServerMessageAssistantSpeechTiming.js"; export * from "./ServerMessageAssistantSpeechType.js"; +export * from "./ServerMessageCallArtifactUpload.js"; +export * from "./ServerMessageCallArtifactUploadPhoneNumber.js"; +export * from "./ServerMessageCallArtifactUploadType.js"; export * from "./ServerMessageCallDeleted.js"; export * from "./ServerMessageCallDeletedPhoneNumber.js"; export * from "./ServerMessageCallDeletedType.js"; @@ -1245,6 +1397,9 @@ export * from "./ServerMessageCallEndpointingRequest.js"; export * from "./ServerMessageCallEndpointingRequestMessagesItem.js"; export * from "./ServerMessageCallEndpointingRequestPhoneNumber.js"; export * from "./ServerMessageCallEndpointingRequestType.js"; +export * from "./ServerMessageCampaignPredial.js"; +export * from "./ServerMessageCampaignPredialPhoneNumber.js"; +export * from "./ServerMessageCampaignPredialType.js"; export * from "./ServerMessageChatCreated.js"; export * from "./ServerMessageChatCreatedPhoneNumber.js"; export * from "./ServerMessageChatCreatedType.js"; @@ -1287,6 +1442,7 @@ export * from "./ServerMessageResponse.js"; export * from "./ServerMessageResponseAssistantRequest.js"; export * from "./ServerMessageResponseAssistantRequestDestination.js"; export * from "./ServerMessageResponseCallEndpointingRequest.js"; +export * from "./ServerMessageResponseCampaignPredial.js"; export * from "./ServerMessageResponseHandoffDestinationRequest.js"; export * from "./ServerMessageResponseKnowledgeBaseRequest.js"; export * from "./ServerMessageResponseMessageResponse.js"; @@ -1370,16 +1526,28 @@ export * from "./SimulationRunItemImprovements.js"; export * from "./SimulationRunItemMetadata.js"; export * from "./SimulationRunItemResults.js"; export * from "./SimulationRunItemStatus.js"; +export * from "./SimulationRunListItem.js"; +export * from "./SimulationRunListItemSimulationsItem.js"; +export * from "./SimulationRunListItemStatus.js"; +export * from "./SimulationRunListItemTarget.js"; +export * from "./SimulationRunListSource.js"; +export * from "./SimulationRunListSourceType.js"; +export * from "./SimulationRunListSummary.js"; +export * from "./SimulationRunPaymentRequiredResponse.js"; +export * from "./SimulationRunPaymentRequiredResponseReason.js"; export * from "./SimulationRunSimulationEntry.js"; export * from "./SimulationRunSimulationsItem.js"; export * from "./SimulationRunStatus.js"; export * from "./SimulationRunSuiteEntry.js"; +export * from "./SimulationRunsPaginatedResponse.js"; export * from "./SimulationRunTarget.js"; export * from "./SimulationRunTargetAssistant.js"; export * from "./SimulationRunTargetSquad.js"; export * from "./SimulationRunTransportConfiguration.js"; export * from "./SimulationRunTransportConfigurationProvider.js"; export * from "./SimulationSuite.js"; +export * from "./SimulationSuiteTargetAssignment.js"; +export * from "./SimulationSuiteTargetAssignmentTargetType.js"; export * from "./SipAuthentication.js"; export * from "./SipRequestTool.js"; export * from "./SipRequestToolBody.js"; @@ -1389,6 +1557,8 @@ export * from "./SipTrunkGateway.js"; export * from "./SipTrunkGatewayOutboundProtocol.js"; export * from "./SipTrunkOutboundAuthenticationPlan.js"; export * from "./SipTrunkOutboundSipRegisterPlan.js"; +export * from "./SkippedStructuredOutput.js"; +export * from "./SkippedStructuredOutputUnmetCondition.js"; export * from "./SlackOAuth2AuthorizationCredential.js"; export * from "./SlackOAuth2AuthorizationCredentialProvider.js"; export * from "./SlackSendMessageTool.js"; @@ -1404,10 +1574,12 @@ export * from "./SmallestAiVoiceModel.js"; export * from "./SmartDenoisingPlan.js"; export * from "./SmsTool.js"; export * from "./SmsToolMessagesItem.js"; +export * from "./SonioxContextGeneralItem.js"; export * from "./SonioxCredential.js"; export * from "./SonioxCredentialProvider.js"; export * from "./SonioxTranscriber.js"; export * from "./SonioxTranscriberLanguage.js"; +export * from "./SonioxTranscriberLanguagesItem.js"; export * from "./SonioxTranscriberModel.js"; export * from "./SpeechmaticsCredential.js"; export * from "./SpeechmaticsCredentialProvider.js"; @@ -1435,6 +1607,8 @@ export * from "./StopSpeakingPlan.js"; export * from "./StructuredDataMultiPlan.js"; export * from "./StructuredDataPlan.js"; export * from "./StructuredOutput.js"; +export * from "./StructuredOutputConditionsItem.js"; +export * from "./StructuredOutputCostBreakdown.js"; export * from "./StructuredOutputEvaluationResult.js"; export * from "./StructuredOutputEvaluationResultComparator.js"; export * from "./StructuredOutputEvaluationResultExpectedValue.js"; @@ -1442,6 +1616,10 @@ export * from "./StructuredOutputEvaluationResultExtractedValue.js"; export * from "./StructuredOutputFilterDto.js"; export * from "./StructuredOutputModel.js"; export * from "./StructuredOutputPaginatedResponse.js"; +export * from "./StructuredOutputRerunResponse.js"; +export * from "./StructuredOutputRunPreviewResponse.js"; +export * from "./StructuredOutputRunResult.js"; +export * from "./StructuredOutputRunResultResult.js"; export * from "./StructuredOutputType.js"; export * from "./Subscription.js"; export * from "./SubscriptionLimits.js"; @@ -1472,6 +1650,8 @@ export * from "./TelnyxPhoneNumber.js"; export * from "./TelnyxPhoneNumberFallbackDestination.js"; export * from "./TelnyxPhoneNumberHooksItem.js"; export * from "./TelnyxPhoneNumberStatus.js"; +export * from "./TelnyxTransport.js"; +export * from "./TelnyxTransportConversationType.js"; export * from "./Template.js"; export * from "./TemplateDetails.js"; export * from "./TemplateProvider.js"; @@ -1533,24 +1713,46 @@ export * from "./ToolCallHookActionType.js"; export * from "./ToolCallMessage.js"; export * from "./ToolCallResult.js"; export * from "./ToolCallResultMessage.js"; +export * from "./ToolCallResultMessageWarning.js"; +export * from "./ToolCallResultMessageWarningType.js"; +export * from "./ToolDraft.js"; +export * from "./ToolDraftConflictResponseDto.js"; +export * from "./ToolDraftMessagesItem.js"; +export * from "./ToolDraftMethod.js"; +export * from "./ToolDraftPaginatedMetadata.js"; +export * from "./ToolDraftPaginatedResponse.js"; +export * from "./ToolDraftType.js"; +export * from "./ToolDraftVerb.js"; export * from "./ToolMessage.js"; export * from "./ToolMessageComplete.js"; export * from "./ToolMessageCompleteRole.js"; export * from "./ToolMessageDelayed.js"; export * from "./ToolMessageFailed.js"; +export * from "./ToolMessageFailedRole.js"; export * from "./ToolMessageRole.js"; export * from "./ToolMessageStart.js"; export * from "./ToolNode.js"; export * from "./ToolNodeTool.js"; export * from "./ToolParameter.js"; export * from "./ToolParameterValue.js"; +export * from "./ToolPinnedConflictResponseDto.js"; +export * from "./ToolPinnedConflictResponseDtoError.js"; +export * from "./ToolRef.js"; export * from "./ToolRejectionPlan.js"; export * from "./ToolRejectionPlanConditionsItem.js"; export * from "./ToolTemplateMetadata.js"; export * from "./ToolTemplateSetup.js"; +export * from "./ToolVersion.js"; +export * from "./ToolVersionPaginatedMetadata.js"; +export * from "./ToolVersionPaginatedResponse.js"; export * from "./TranscriberCost.js"; export * from "./TranscriptionEndpointingPlan.js"; export * from "./TranscriptPlan.js"; +export * from "./TransferArtifact.js"; +export * from "./TransferArtifactDestination.js"; +export * from "./TransferArtifactMessagesItem.js"; +export * from "./TransferArtifactMode.js"; +export * from "./TransferArtifactStatus.js"; export * from "./TransferAssistant.js"; export * from "./TransferAssistantBackgroundSound.js"; export * from "./TransferAssistantBackgroundSoundZero.js"; @@ -1593,17 +1795,8 @@ export * from "./TransportConfigurationTwilioProvider.js"; export * from "./TransportConfigurationTwilioRecordingChannels.js"; export * from "./TransportCost.js"; export * from "./TransportCostProvider.js"; -export * from "./TrieveCredential.js"; -export * from "./TrieveCredentialProvider.js"; export * from "./TrieveKnowledgeBase.js"; -export * from "./TrieveKnowledgeBaseChunkPlan.js"; -export * from "./TrieveKnowledgeBaseCreate.js"; -export * from "./TrieveKnowledgeBaseCreateType.js"; export * from "./TrieveKnowledgeBaseImport.js"; -export * from "./TrieveKnowledgeBaseImportType.js"; -export * from "./TrieveKnowledgeBaseProvider.js"; -export * from "./TrieveKnowledgeBaseSearchPlan.js"; -export * from "./TrieveKnowledgeBaseSearchPlanSearchType.js"; export * from "./TurnLatency.js"; export * from "./TwilioCredential.js"; export * from "./TwilioCredentialProvider.js"; @@ -1614,24 +1807,46 @@ export * from "./TwilioPhoneNumberStatus.js"; export * from "./TwilioSmsChatTransport.js"; export * from "./TwilioSmsChatTransportConversationType.js"; export * from "./TwilioSmsChatTransportType.js"; +export * from "./TwilioTransport.js"; +export * from "./TwilioTransportConversationType.js"; export * from "./TwilioTransportMessage.js"; export * from "./TwilioVoicemailDetectionPlan.js"; export * from "./TwilioVoicemailDetectionPlanProvider.js"; export * from "./TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem.js"; export * from "./UpdateAnthropicBedrockCredentialDto.js"; export * from "./UpdateAnthropicBedrockCredentialDtoAuthenticationPlan.js"; +export * from "./UpdateAnthropicBedrockCredentialDtoProvider.js"; export * from "./UpdateAnthropicBedrockCredentialDtoRegion.js"; export * from "./UpdateAnthropicCredentialDto.js"; +export * from "./UpdateAnthropicCredentialDtoProvider.js"; export * from "./UpdateAnyscaleCredentialDto.js"; +export * from "./UpdateAnyscaleCredentialDtoProvider.js"; export * from "./UpdateApiRequestToolDto.js"; export * from "./UpdateApiRequestToolDtoMessagesItem.js"; export * from "./UpdateApiRequestToolDtoMethod.js"; export * from "./UpdateAssemblyAiCredentialDto.js"; +export * from "./UpdateAssemblyAiCredentialDtoProvider.js"; +export * from "./UpdateAssistantDraftDto.js"; +export * from "./UpdateAssistantDraftDtoBackgroundSound.js"; +export * from "./UpdateAssistantDraftDtoBackgroundSoundZero.js"; +export * from "./UpdateAssistantDraftDtoClientMessagesItem.js"; +export * from "./UpdateAssistantDraftDtoCredentialsItem.js"; +export * from "./UpdateAssistantDraftDtoFirstMessageMode.js"; +export * from "./UpdateAssistantDraftDtoHooksItem.js"; +export * from "./UpdateAssistantDraftDtoModel.js"; +export * from "./UpdateAssistantDraftDtoServerMessagesItem.js"; +export * from "./UpdateAssistantDraftDtoTranscriber.js"; +export * from "./UpdateAssistantDraftDtoVoice.js"; +export * from "./UpdateAssistantDraftDtoVoicemailDetection.js"; +export * from "./UpdateAssistantDraftDtoVoicemailDetectionZero.js"; +export * from "./UpdateAssistantVersionMetadataDto.js"; export * from "./UpdateAzureCredentialDto.js"; +export * from "./UpdateAzureCredentialDtoProvider.js"; export * from "./UpdateAzureCredentialDtoRegion.js"; export * from "./UpdateAzureCredentialDtoService.js"; export * from "./UpdateAzureOpenAiCredentialDto.js"; export * from "./UpdateAzureOpenAiCredentialDtoModelsItem.js"; +export * from "./UpdateAzureOpenAiCredentialDtoProvider.js"; export * from "./UpdateAzureOpenAiCredentialDtoRegion.js"; export * from "./UpdateBarInsightFromCallTableDto.js"; export * from "./UpdateBarInsightFromCallTableDtoGroupBy.js"; @@ -1644,11 +1859,18 @@ export * from "./UpdateByoPhoneNumberDto.js"; export * from "./UpdateByoPhoneNumberDtoFallbackDestination.js"; export * from "./UpdateByoPhoneNumberDtoHooksItem.js"; export * from "./UpdateByoSipTrunkCredentialDto.js"; +export * from "./UpdateByoSipTrunkCredentialDtoProvider.js"; +export * from "./UpdateCampaignDto.js"; +export * from "./UpdateCampaignDtoStatus.js"; export * from "./UpdateCartesiaCredentialDto.js"; +export * from "./UpdateCartesiaCredentialDtoProvider.js"; export * from "./UpdateCerebrasCredentialDto.js"; +export * from "./UpdateCerebrasCredentialDtoProvider.js"; export * from "./UpdateCloudflareCredentialDto.js"; +export * from "./UpdateCloudflareCredentialDtoProvider.js"; export * from "./UpdateCodeToolDto.js"; export * from "./UpdateCodeToolDtoMessagesItem.js"; +export * from "./UpdateCodeToolDtoType.js"; export * from "./UpdateComputerToolDto.js"; export * from "./UpdateComputerToolDtoMessagesItem.js"; export * from "./UpdateComputerToolDtoName.js"; @@ -1656,23 +1878,34 @@ export * from "./UpdateComputerToolDtoSubType.js"; export * from "./UpdateCustomCredentialDto.js"; export * from "./UpdateCustomCredentialDtoAuthenticationPlan.js"; export * from "./UpdateCustomCredentialDtoEncryptionPlan.js"; +export * from "./UpdateCustomCredentialDtoProvider.js"; export * from "./UpdateCustomKnowledgeBaseDto.js"; +export * from "./UpdateCustomKnowledgeBaseDtoProvider.js"; export * from "./UpdateCustomLlmCredentialDto.js"; +export * from "./UpdateCustomLlmCredentialDtoProvider.js"; export * from "./UpdateDeepgramCredentialDto.js"; +export * from "./UpdateDeepgramCredentialDtoProvider.js"; export * from "./UpdateDeepInfraCredentialDto.js"; +export * from "./UpdateDeepInfraCredentialDtoProvider.js"; export * from "./UpdateDeepSeekCredentialDto.js"; +export * from "./UpdateDeepSeekCredentialDtoProvider.js"; export * from "./UpdateDtmfToolDto.js"; export * from "./UpdateDtmfToolDtoMessagesItem.js"; export * from "./UpdateElevenLabsCredentialDto.js"; +export * from "./UpdateElevenLabsCredentialDtoApiUrl.js"; export * from "./UpdateEmailCredentialDto.js"; +export * from "./UpdateEmailCredentialDtoProvider.js"; export * from "./UpdateEndCallToolDto.js"; export * from "./UpdateEndCallToolDtoMessagesItem.js"; export * from "./UpdateFunctionToolDto.js"; export * from "./UpdateFunctionToolDtoMessagesItem.js"; export * from "./UpdateGcpCredentialDto.js"; +export * from "./UpdateGcpCredentialDtoProvider.js"; export * from "./UpdateGhlToolDto.js"; export * from "./UpdateGhlToolDtoMessagesItem.js"; +export * from "./UpdateGhlToolDtoType.js"; export * from "./UpdateGladiaCredentialDto.js"; +export * from "./UpdateGladiaCredentialDtoProvider.js"; export * from "./UpdateGoHighLevelCalendarAvailabilityToolDto.js"; export * from "./UpdateGoHighLevelCalendarAvailabilityToolDtoMessagesItem.js"; export * from "./UpdateGoHighLevelCalendarEventCreateToolDto.js"; @@ -1682,68 +1915,97 @@ export * from "./UpdateGoHighLevelContactCreateToolDtoMessagesItem.js"; export * from "./UpdateGoHighLevelContactGetToolDto.js"; export * from "./UpdateGoHighLevelContactGetToolDtoMessagesItem.js"; export * from "./UpdateGoHighLevelCredentialDto.js"; +export * from "./UpdateGoHighLevelCredentialDtoProvider.js"; export * from "./UpdateGoHighLevelMcpCredentialDto.js"; +export * from "./UpdateGoHighLevelMcpCredentialDtoProvider.js"; export * from "./UpdateGoogleCalendarCheckAvailabilityToolDto.js"; export * from "./UpdateGoogleCalendarCheckAvailabilityToolDtoMessagesItem.js"; export * from "./UpdateGoogleCalendarCreateEventToolDto.js"; export * from "./UpdateGoogleCalendarCreateEventToolDtoMessagesItem.js"; export * from "./UpdateGoogleCalendarOAuth2AuthorizationCredentialDto.js"; +export * from "./UpdateGoogleCalendarOAuth2AuthorizationCredentialDtoProvider.js"; export * from "./UpdateGoogleCalendarOAuth2ClientCredentialDto.js"; +export * from "./UpdateGoogleCalendarOAuth2ClientCredentialDtoProvider.js"; export * from "./UpdateGoogleCredentialDto.js"; +export * from "./UpdateGoogleCredentialDtoProvider.js"; export * from "./UpdateGoogleSheetsOAuth2AuthorizationCredentialDto.js"; +export * from "./UpdateGoogleSheetsOAuth2AuthorizationCredentialDtoProvider.js"; export * from "./UpdateGoogleSheetsRowAppendToolDto.js"; export * from "./UpdateGoogleSheetsRowAppendToolDtoMessagesItem.js"; export * from "./UpdateGroqCredentialDto.js"; +export * from "./UpdateGroqCredentialDtoProvider.js"; export * from "./UpdateHandoffToolDto.js"; export * from "./UpdateHandoffToolDtoDestinationsItem.js"; export * from "./UpdateHandoffToolDtoMessagesItem.js"; export * from "./UpdateHumeCredentialDto.js"; +export * from "./UpdateHumeCredentialDtoProvider.js"; export * from "./UpdateInflectionAiCredentialDto.js"; +export * from "./UpdateInflectionAiCredentialDtoProvider.js"; export * from "./UpdateInworldCredentialDto.js"; +export * from "./UpdateInworldCredentialDtoProvider.js"; +export * from "./UpdateKnowledgeBaseToolDto.js"; +export * from "./UpdateKnowledgeBaseToolDtoMessagesItem.js"; export * from "./UpdateLangfuseCredentialDto.js"; +export * from "./UpdateLangfuseCredentialDtoProvider.js"; export * from "./UpdateLineInsightFromCallTableDto.js"; export * from "./UpdateLineInsightFromCallTableDtoGroupBy.js"; export * from "./UpdateLineInsightFromCallTableDtoQueriesItem.js"; export * from "./UpdateLmntCredentialDto.js"; +export * from "./UpdateLmntCredentialDtoProvider.js"; export * from "./UpdateMakeCredentialDto.js"; +export * from "./UpdateMakeCredentialDtoProvider.js"; export * from "./UpdateMakeToolDto.js"; export * from "./UpdateMakeToolDtoMessagesItem.js"; +export * from "./UpdateMakeToolDtoType.js"; export * from "./UpdateMcpToolDto.js"; export * from "./UpdateMcpToolDtoMessagesItem.js"; +export * from "./UpdateMicrosoftCredentialDto.js"; +export * from "./UpdateMicrosoftCredentialDtoProvider.js"; export * from "./UpdateMistralCredentialDto.js"; +export * from "./UpdateMistralCredentialDtoProvider.js"; export * from "./UpdateNeuphonicCredentialDto.js"; +export * from "./UpdateNeuphonicCredentialDtoProvider.js"; export * from "./UpdateOpenAiCredentialDto.js"; +export * from "./UpdateOpenAiCredentialDtoProvider.js"; export * from "./UpdateOpenRouterCredentialDto.js"; +export * from "./UpdateOpenRouterCredentialDtoProvider.js"; export * from "./UpdateOrgDto.js"; export * from "./UpdateOrgDtoChannel.js"; export * from "./UpdateOutputToolDto.js"; export * from "./UpdateOutputToolDtoMessagesItem.js"; +export * from "./UpdateOutputToolDtoType.js"; export * from "./UpdatePerplexityAiCredentialDto.js"; -export * from "./UpdatePersonalityDto.js"; +export * from "./UpdatePerplexityAiCredentialDtoProvider.js"; export * from "./UpdatePieInsightFromCallTableDto.js"; export * from "./UpdatePieInsightFromCallTableDtoGroupBy.js"; export * from "./UpdatePieInsightFromCallTableDtoQueriesItem.js"; export * from "./UpdatePlayHtCredentialDto.js"; +export * from "./UpdatePlayHtCredentialDtoProvider.js"; export * from "./UpdateQueryToolDto.js"; export * from "./UpdateQueryToolDtoMessagesItem.js"; export * from "./UpdateRimeAiCredentialDto.js"; +export * from "./UpdateRimeAiCredentialDtoProvider.js"; export * from "./UpdateRunpodCredentialDto.js"; +export * from "./UpdateRunpodCredentialDtoProvider.js"; +export * from "./UpdateS3CompatibleBucketPlanDto.js"; +export * from "./UpdateS3CompatibleCredentialDto.js"; +export * from "./UpdateS3CompatibleCredentialDtoProvider.js"; export * from "./UpdateS3CredentialDto.js"; -export * from "./UpdateScenarioDto.js"; -export * from "./UpdateScenarioDtoHooksItem.js"; -export * from "./UpdateSimulationDto.js"; -export * from "./UpdateSimulationSuiteDto.js"; +export * from "./UpdateS3CredentialDtoProvider.js"; export * from "./UpdateSipRequestToolDto.js"; export * from "./UpdateSipRequestToolDtoBody.js"; export * from "./UpdateSipRequestToolDtoMessagesItem.js"; export * from "./UpdateSipRequestToolDtoVerb.js"; export * from "./UpdateSlackOAuth2AuthorizationCredentialDto.js"; +export * from "./UpdateSlackOAuth2AuthorizationCredentialDtoProvider.js"; export * from "./UpdateSlackSendMessageToolDto.js"; export * from "./UpdateSlackSendMessageToolDtoMessagesItem.js"; export * from "./UpdateSlackWebhookCredentialDto.js"; +export * from "./UpdateSlackWebhookCredentialDtoProvider.js"; export * from "./UpdateSmsToolDto.js"; export * from "./UpdateSmsToolDtoMessagesItem.js"; export * from "./UpdateSonioxCredentialDto.js"; +export * from "./UpdateSonioxCredentialDtoProvider.js"; export * from "./UpdateTelnyxPhoneNumberDto.js"; export * from "./UpdateTelnyxPhoneNumberDtoFallbackDestination.js"; export * from "./UpdateTelnyxPhoneNumberDtoHooksItem.js"; @@ -1760,37 +2022,49 @@ export * from "./UpdateTextEditorToolDtoSubType.js"; export * from "./UpdateTextInsightFromCallTableDto.js"; export * from "./UpdateTextInsightFromCallTableDtoQueriesItem.js"; export * from "./UpdateTogetherAiCredentialDto.js"; +export * from "./UpdateTogetherAiCredentialDtoProvider.js"; export * from "./UpdateTokenDto.js"; export * from "./UpdateTokenDtoTag.js"; +export * from "./UpdateToolDraftDto.js"; +export * from "./UpdateToolDraftDtoMessagesItem.js"; +export * from "./UpdateToolDraftDtoMethod.js"; +export * from "./UpdateToolDraftDtoType.js"; +export * from "./UpdateToolDraftDtoVerb.js"; export * from "./UpdateToolTemplateDto.js"; export * from "./UpdateToolTemplateDtoDetails.js"; export * from "./UpdateToolTemplateDtoProvider.js"; export * from "./UpdateToolTemplateDtoProviderDetails.js"; export * from "./UpdateToolTemplateDtoType.js"; export * from "./UpdateToolTemplateDtoVisibility.js"; +export * from "./UpdateToolVersionMetadataDto.js"; export * from "./UpdateTransferCallToolDto.js"; export * from "./UpdateTransferCallToolDtoDestinationsItem.js"; export * from "./UpdateTransferCallToolDtoMessagesItem.js"; -export * from "./UpdateTrieveCredentialDto.js"; export * from "./UpdateTrieveKnowledgeBaseDto.js"; export * from "./UpdateTwilioCredentialDto.js"; +export * from "./UpdateTwilioCredentialDtoProvider.js"; export * from "./UpdateTwilioPhoneNumberDto.js"; export * from "./UpdateTwilioPhoneNumberDtoFallbackDestination.js"; export * from "./UpdateTwilioPhoneNumberDtoHooksItem.js"; export * from "./UpdateUserRoleDto.js"; export * from "./UpdateUserRoleDtoRole.js"; +export * from "./UpdateUserRoleDtoRoleZero.js"; export * from "./UpdateVapiPhoneNumberDto.js"; export * from "./UpdateVapiPhoneNumberDtoFallbackDestination.js"; export * from "./UpdateVapiPhoneNumberDtoHooksItem.js"; +export * from "./UpdateVoiceLibraryMetadataDto.js"; export * from "./UpdateVoicemailToolDto.js"; export * from "./UpdateVoicemailToolDtoMessagesItem.js"; export * from "./UpdateVonageCredentialDto.js"; +export * from "./UpdateVonageCredentialDtoProvider.js"; export * from "./UpdateVonagePhoneNumberDto.js"; export * from "./UpdateVonagePhoneNumberDtoFallbackDestination.js"; export * from "./UpdateVonagePhoneNumberDtoHooksItem.js"; export * from "./UpdateWebhookCredentialDto.js"; export * from "./UpdateWebhookCredentialDtoAuthenticationPlan.js"; +export * from "./UpdateWebhookCredentialDtoProvider.js"; export * from "./UpdateWellSaidCredentialDto.js"; +export * from "./UpdateWellSaidCredentialDtoProvider.js"; export * from "./UpdateWorkflowDto.js"; export * from "./UpdateWorkflowDtoBackgroundSound.js"; export * from "./UpdateWorkflowDtoBackgroundSoundZero.js"; @@ -1803,34 +2077,54 @@ export * from "./UpdateWorkflowDtoVoice.js"; export * from "./UpdateWorkflowDtoVoicemailDetection.js"; export * from "./UpdateWorkflowDtoVoicemailDetectionZero.js"; export * from "./UpdateXAiCredentialDto.js"; +export * from "./UpdateXAiCredentialDtoProvider.js"; export * from "./User.js"; export * from "./UserMessage.js"; export * from "./VapiCost.js"; export * from "./VapiCostSubType.js"; export * from "./VapiModel.js"; -export * from "./VapiModelProvider.js"; export * from "./VapiModelToolsItem.js"; +export * from "./VapiModelVersion.js"; export * from "./VapiPhoneNumber.js"; export * from "./VapiPhoneNumberFallbackDestination.js"; export * from "./VapiPhoneNumberHooksItem.js"; export * from "./VapiPhoneNumberStatus.js"; export * from "./VapiPronunciationDictionaryLocator.js"; +export * from "./VapiPronunciationDictionaryLocatorProvider.js"; +export * from "./VapiSipTransport.js"; +export * from "./VapiSipTransportConversationType.js"; export * from "./VapiSipTransportMessage.js"; export * from "./VapiSipTransportMessageSipVerb.js"; export * from "./VapiSmartEndpointingPlan.js"; export * from "./VapiSmartEndpointingPlanProvider.js"; +export * from "./VapiTranscriber.js"; +export * from "./VapiTranscriberLanguage.js"; +export * from "./VapiTranscriberLanguagesItem.js"; +export * from "./VapiTranscriberTurnTaking.js"; +export * from "./VapiTranscriberVersion.js"; export * from "./VapiVoice.js"; +export * from "./VapiVoiceCloneDto.js"; +export * from "./VapiVoiceLanguage.js"; export * from "./VapiVoicemailDetectionPlan.js"; export * from "./VapiVoicemailDetectionPlanProvider.js"; export * from "./VapiVoicemailDetectionPlanType.js"; -export * from "./VapiVoiceVoiceId.js"; +export * from "./VapiVoiceVersion.js"; +export * from "./VapiWebCallTransport.js"; +export * from "./VapiWebCallTransportConversationType.js"; +export * from "./VapiWebsocketTransport.js"; +export * from "./VapiWebsocketTransportConversationType.js"; export * from "./VariableExtractionAlias.js"; export * from "./VariableExtractionPlan.js"; export * from "./VariableValueGroupBy.js"; +export * from "./VersionPinConflictResponseDto.js"; +export * from "./VersionPinConflictResponseDtoError.js"; +export * from "./VersionPinReference.js"; +export * from "./VersionPinReferenceSourceType.js"; export * from "./VoiceCost.js"; export * from "./VoiceLibrary.js"; export * from "./VoiceLibraryGender.js"; export * from "./VoiceLibraryVoiceResponse.js"; +export * from "./VoiceLibraryVoiceResponseAge.js"; export * from "./VoicemailDetectionBackoffPlan.js"; export * from "./VoicemailDetectionCost.js"; export * from "./VoicemailDetectionCostProvider.js"; @@ -1842,6 +2136,8 @@ export * from "./VonagePhoneNumber.js"; export * from "./VonagePhoneNumberFallbackDestination.js"; export * from "./VonagePhoneNumberHooksItem.js"; export * from "./VonagePhoneNumberStatus.js"; +export * from "./VonageTransport.js"; +export * from "./VonageTransportConversationType.js"; export * from "./WebChat.js"; export * from "./WebChatOutputItem.js"; export * from "./WebhookCredential.js"; @@ -1889,5 +2185,11 @@ export * from "./XAiCredentialProvider.js"; export * from "./XaiModel.js"; export * from "./XaiModelModel.js"; export * from "./XaiModelToolsItem.js"; +export * from "./XaiTranscriber.js"; +export * from "./XaiTranscriberLanguage.js"; +export * from "./XaiTranscriberModel.js"; +export * from "./XaiVoice.js"; +export * from "./XaiVoiceLanguage.js"; +export * from "./XaiVoiceVoiceId.js"; export * from "./XssSecurityFilter.js"; export * from "./XssSecurityFilterType.js"; diff --git a/src/version.ts b/src/version.ts index 478f50d1..02d1eb13 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.0.0"; +export const SDK_VERSION = "0.0.0-fern-placeholder"; diff --git a/tests/wire/assistants.test.ts b/tests/wire/assistants.test.ts index 06e7e9d4..bc8a7ea5 100644 --- a/tests/wire/assistants.test.ts +++ b/tests/wire/assistants.test.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +import * as Vapi from "../../src/api/index"; import { VapiClient } from "../../src/Client"; import { mockServerPool } from "../mock-server/MockServerPool"; @@ -19,6 +20,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -73,6 +78,7 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -239,6 +245,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -336,13 +343,24 @@ describe("AssistantsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -451,6 +469,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -527,6 +549,12 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -742,6 +770,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -851,6 +880,16 @@ describe("AssistantsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -862,12 +901,15 @@ describe("AssistantsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -1009,6 +1051,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -1063,6 +1109,7 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -1175,7 +1222,7 @@ describe("AssistantsClient", () => { tags: ["tags"], metadata: { key: "value" }, }, - credentials: [{ provider: "11labs", apiKey: "apiKey", name: "name" }], + credentials: [{ provider: "11labs", apiKey: "apiKey", apiUrl: "https://api.elevenlabs.io", name: "name" }], hooks: [ { on: "call.ending", @@ -1215,6 +1262,7 @@ describe("AssistantsClient", () => { filters: [{ type: "oneOf", key: "key", oneOf: ["oneOf"] }], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -1288,6 +1336,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -1333,11 +1382,26 @@ describe("AssistantsClient", () => { recordingPath: "recordingPath", structuredOutputIds: ["structuredOutputIds"], structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -1451,6 +1515,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -1527,6 +1595,12 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -1686,6 +1760,7 @@ describe("AssistantsClient", () => { { provider: "11labs", apiKey: "apiKey", + apiUrl: "https://api.elevenlabs.io", name: "name", }, ], @@ -1751,6 +1826,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -1830,6 +1906,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -1905,6 +1982,16 @@ describe("AssistantsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -1916,12 +2003,15 @@ describe("AssistantsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -2062,6 +2152,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -2116,6 +2210,7 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -2228,7 +2323,7 @@ describe("AssistantsClient", () => { tags: ["tags"], metadata: { key: "value" }, }, - credentials: [{ provider: "11labs", apiKey: "apiKey", name: "name" }], + credentials: [{ provider: "11labs", apiKey: "apiKey", apiUrl: "https://api.elevenlabs.io", name: "name" }], hooks: [ { on: "call.ending", @@ -2268,6 +2363,7 @@ describe("AssistantsClient", () => { filters: [{ type: "oneOf", key: "key", oneOf: ["oneOf"] }], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -2341,6 +2437,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -2386,11 +2483,26 @@ describe("AssistantsClient", () => { recordingPath: "recordingPath", structuredOutputIds: ["structuredOutputIds"], structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -2499,6 +2611,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -2575,6 +2691,12 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -2734,6 +2856,7 @@ describe("AssistantsClient", () => { { provider: "11labs", apiKey: "apiKey", + apiUrl: "https://api.elevenlabs.io", name: "name", }, ], @@ -2799,6 +2922,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -2878,6 +3002,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -2953,6 +3078,16 @@ describe("AssistantsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2964,12 +3099,15 @@ describe("AssistantsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -3096,7 +3234,7 @@ describe("AssistantsClient", () => { }); }); - test("delete", async () => { + test("delete (1)", async () => { const server = mockServerPool.createServer(); const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); @@ -3110,6 +3248,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -3164,6 +3306,7 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -3276,7 +3419,7 @@ describe("AssistantsClient", () => { tags: ["tags"], metadata: { key: "value" }, }, - credentials: [{ provider: "11labs", apiKey: "apiKey", name: "name" }], + credentials: [{ provider: "11labs", apiKey: "apiKey", apiUrl: "https://api.elevenlabs.io", name: "name" }], hooks: [ { on: "call.ending", @@ -3316,6 +3459,7 @@ describe("AssistantsClient", () => { filters: [{ type: "oneOf", key: "key", oneOf: ["oneOf"] }], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -3389,6 +3533,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -3434,11 +3579,26 @@ describe("AssistantsClient", () => { recordingPath: "recordingPath", structuredOutputIds: ["structuredOutputIds"], structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -3547,6 +3707,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -3623,6 +3787,12 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -3782,6 +3952,7 @@ describe("AssistantsClient", () => { { provider: "11labs", apiKey: "apiKey", + apiUrl: "https://api.elevenlabs.io", name: "name", }, ], @@ -3847,6 +4018,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -3926,6 +4098,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -4001,6 +4174,16 @@ describe("AssistantsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4012,12 +4195,15 @@ describe("AssistantsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -4144,6 +4330,21 @@ describe("AssistantsClient", () => { }); }); + test("delete (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { key: "value" }; + + server.mockEndpoint().delete("/assistant/id").respondWith().statusCode(409).jsonBody(rawResponseBody).build(); + + await expect(async () => { + return await client.assistants.delete({ + id: "id", + }); + }).rejects.toThrow(Vapi.ConflictError); + }); + test("update", async () => { const server = mockServerPool.createServer(); const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); @@ -4158,6 +4359,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -4212,6 +4417,7 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -4324,7 +4530,7 @@ describe("AssistantsClient", () => { tags: ["tags"], metadata: { key: "value" }, }, - credentials: [{ provider: "11labs", apiKey: "apiKey", name: "name" }], + credentials: [{ provider: "11labs", apiKey: "apiKey", apiUrl: "https://api.elevenlabs.io", name: "name" }], hooks: [ { on: "call.ending", @@ -4364,6 +4570,7 @@ describe("AssistantsClient", () => { filters: [{ type: "oneOf", key: "key", oneOf: ["oneOf"] }], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -4437,6 +4644,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -4482,11 +4690,26 @@ describe("AssistantsClient", () => { recordingPath: "recordingPath", structuredOutputIds: ["structuredOutputIds"], structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -4602,6 +4825,10 @@ describe("AssistantsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -4678,6 +4905,12 @@ describe("AssistantsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -4837,6 +5070,7 @@ describe("AssistantsClient", () => { { provider: "11labs", apiKey: "apiKey", + apiUrl: "https://api.elevenlabs.io", name: "name", }, ], @@ -4902,6 +5136,7 @@ describe("AssistantsClient", () => { ], }, ], + latestVersion: "latestVersion", name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -4981,6 +5216,7 @@ describe("AssistantsClient", () => { ], }, }, + firstMessageMode: "assistant-speaks-first", waitSeconds: 3, }, }, @@ -5056,6 +5292,16 @@ describe("AssistantsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -5067,12 +5313,15 @@ describe("AssistantsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, diff --git a/tests/wire/board.test.ts b/tests/wire/board.test.ts new file mode 100644 index 00000000..f518717a --- /dev/null +++ b/tests/wire/board.test.ts @@ -0,0 +1,467 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("BoardClient", () => { + test("BoardController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + results: [ + { + items: [ + { + type: "insight", + insightId: "insightId", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { start: { key: "value" }, end: { key: "value" } }, + }, + ], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z", + }, + }; + + server.mockEndpoint().get("/reporting/board").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.board.boardControllerFindAll(); + expect(response).toEqual({ + results: [ + { + items: [ + { + type: "insight", + insightId: "insightId", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + start: { + key: "value", + }, + end: { + key: "value", + }, + }, + }, + ], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z", + }, + }); + }); + + test("BoardController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { name: "name", layout: { columns: 1.1 } }; + const rawResponseBody = { + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { step: "minute", start: { key: "value" }, end: { key: "value" }, timezone: "timezone" }, + }; + + server + .mockEndpoint() + .post("/reporting/board") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.board.boardControllerCreate({ + name: "name", + layout: { + columns: 1.1, + }, + }); + expect(response).toEqual({ + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + step: "minute", + start: { + key: "value", + }, + end: { + key: "value", + }, + timezone: "timezone", + }, + }); + }); + + test("BoardController_metricsOverviewEnsure", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { step: "minute", start: { key: "value" }, end: { key: "value" }, timezone: "timezone" }, + }; + + server + .mockEndpoint() + .get("/reporting/board/default/metrics-overview") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.board.boardControllerMetricsOverviewEnsure(); + expect(response).toEqual({ + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + step: "minute", + start: { + key: "value", + }, + end: { + key: "value", + }, + timezone: "timezone", + }, + }); + }); + + test("BoardController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { step: "minute", start: { key: "value" }, end: { key: "value" }, timezone: "timezone" }, + }; + + server + .mockEndpoint() + .get("/reporting/board/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.board.boardControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + step: "minute", + start: { + key: "value", + }, + end: { + key: "value", + }, + timezone: "timezone", + }, + }); + }); + + test("BoardController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { step: "minute", start: { key: "value" }, end: { key: "value" }, timezone: "timezone" }, + }; + + server + .mockEndpoint() + .delete("/reporting/board/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.board.boardControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + step: "minute", + start: { + key: "value", + }, + end: { + key: "value", + }, + timezone: "timezone", + }, + }); + }); + + test("BoardController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { x: 1.1, y: 1.1 }, + size: { width: 1.1, height: 1.1 }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { columns: 1.1 }, + timeRangeOverride: { step: "minute", start: { key: "value" }, end: { key: "value" }, timezone: "timezone" }, + }; + + server + .mockEndpoint() + .patch("/reporting/board/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.board.boardControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + items: [ + { + type: "insight", + insightId: "insightId", + systemKey: "systemKey", + position: { + x: 1.1, + y: 1.1, + }, + size: { + width: 1.1, + height: 1.1, + }, + }, + ], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", + name: "name", + layout: { + columns: 1.1, + }, + timeRangeOverride: { + step: "minute", + start: { + key: "value", + }, + end: { + key: "value", + }, + timezone: "timezone", + }, + }); + }); +}); diff --git a/tests/wire/calls.test.ts b/tests/wire/calls.test.ts index b80158c3..5ac85cf6 100644 --- a/tests/wire/calls.test.ts +++ b/tests/wire/calls.test.ts @@ -1,183 +1,749 @@ // This file was auto-generated by Fern from our API Definition. +import * as Vapi from "../../src/api/index"; import { VapiClient } from "../../src/Client"; import { mockServerPool } from "../mock-server/MockServerPool"; describe("CallsClient", () => { + test("list", async () => { const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = [ { "type" : "inboundPhoneCall" , "costs" : [ { "type" : "transport" , "minutes" : 1.1 , "cost" : 1.1 } ] , "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "phoneCallTransport" : "sip" , "status" : "scheduled" , "endedReason" : "call-start-error-neither-assistant-nor-server-set" , "endedMessage" : "endedMessage" , "destination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" } , "description" : "description" } , "assistantVersion" : "assistantVersion" , "transport" : { "provider" : "vapi.websocket" , "conversationType" : "voice" , "audioFormat" : { "sampleRate" : 1.1 , "format" : { "key" : "value" } } } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "startedAt" : "2024-01-15T09:30:00Z" , "endedAt" : "2024-01-15T09:30:00Z" , "cost" : 1.1 , "costBreakdown" : { "transport" : 1.1 , "stt" : 1.1 , "llm" : 1.1 , "tts" : 1.1 , "vapi" : 1.1 , "chat" : 1.1 , "total" : 1.1 , "llmPromptTokens" : 1.1 , "llmCompletionTokens" : 1.1 , "llmCachedPromptTokens" : 1.1 , "ttsCharacters" : 1.1 } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "analysis" : { "summary" : "summary" , "structuredData" : { "key" : "value" } , "structuredDataMulti" : [ { "key" : "value" } ] , "successEvaluation" : "successEvaluation" } , "monitor" : { "monitors" : [ { "monitorId" : "monitorId" , "filterPassed" : true } ] , "listenUrl" : "listenUrl" , "controlUrl" : "controlUrl" } , "artifact" : { "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "messagesOpenAIFormatted" : [ { "content" : null , "role" : "assistant" } ] , "skippedStructuredOutputs" : { "key" : { "name" : "name" , "unmetCondition" : { "type" : "minMessages" , "count" : 4 } } } , "transfers" : [ { "destination" : { "type" : "number" , "number" : "number" } } ] , "transcript" : "transcript" , "pcapUrl" : "pcapUrl" , "logUrl" : "logUrl" , "nodes" : [ { } ] , "assistantActivations" : [ { "assistantName" : "assistantName" } ] , "variableValues" : { "key" : "value" } , "structuredOutputs" : { "key" : "value" } , "scorecards" : { "key" : "value" } , "structuredOutputsLastUpdatedAt" : "2024-01-15T09:30:00Z" , "presignedMonoUrl" : "presignedMonoUrl" , "presignedStereoUrl" : "presignedStereoUrl" , "presignedVideoUrl" : "presignedVideoUrl" , "presignedAssistantUrl" : "presignedAssistantUrl" , "presignedCustomerUrl" : "presignedCustomerUrl" , "presignedPcapUrl" : "presignedPcapUrl" , "presignedLogUrl" : "presignedLogUrl" , "presignedUrlsExpiresAt" : "presignedUrlsExpiresAt" } , "compliance" : { "recordingConsent" : { "type" : "stay-on-line" } } , "campaignId" : "campaignId" , "assistantId" : "assistantId" , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadId" : "squadId" , "squad" : { "name" : "name" , "members" : [ { "assistantDestinations" : [ { "type" : "assistant" , "assistantName" : "assistantName" } ] , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "membersOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "workflowId" : "workflowId" , "workflow" : { "nodes" : [ { "type" : "conversation" , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "name" : "name" } ] , "model" : { "provider" : "openai" , "model" : "gpt-5.6-sol" } , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "voicemailDetection" : "off" , "maxDurationSeconds" : 600 , "name" : "name" , "edges" : [ { "from" : "from" , "to" : "to" } ] , "globalPrompt" : "globalPrompt" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "credentialIds" : [ "credentialIds" ] , "voicemailMessage" : "voicemailMessage" } , "workflowOverrides" : { "variableValues" : { "key" : "value" } } , "phoneNumberId" : "phoneNumberId" , "phoneNumber" : { "fallbackDestination" : { "type" : "number" , "number" : "number" } , "hooks" : [ { "on" : "call.ringing" , "do" : [ { "type" : "transfer" } ] } ] , "smsEnabled" : true , "twilioPhoneNumber" : "twilioPhoneNumber" , "twilioAccountSid" : "twilioAccountSid" , "twilioAuthToken" : "twilioAuthToken" , "twilioApiKey" : "twilioApiKey" , "twilioApiSecret" : "twilioApiSecret" , "name" : "name" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "customerId" : "customerId" , "customer" : { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } , "name" : "name" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } } ]; + + server + .mockEndpoint() + .get("/call").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); - const rawResponseBody = [ - { - type: "inboundPhoneCall", - costs: [{ type: "transport", minutes: 1.1, cost: 1.1 }], - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", + + + const response = await client.calls.list(); + expect(response).toEqual([{ + type: "inboundPhoneCall", + costs: [{ + type: "transport", + minutes: 1.1, + cost: 1.1 + }], + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + phoneCallTransport: "sip", + status: "scheduled", + endedReason: "call-start-error-neither-assistant-nor-server-set", + endedMessage: "endedMessage", + destination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer" + }, + description: "description" + }, + assistantVersion: "assistantVersion", + transport: { + provider: "vapi.websocket", + conversationType: "voice", + audioFormat: { + sampleRate: 1.1, + format: { + "key": "value" + } + } + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costBreakdown: { + transport: 1.1, + stt: 1.1, + llm: 1.1, + tts: 1.1, + vapi: 1.1, + chat: 1.1, + total: 1.1, + llmPromptTokens: 1.1, + llmCompletionTokens: 1.1, + llmCachedPromptTokens: 1.1, + ttsCharacters: 1.1 + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + analysis: { + summary: "summary", + structuredData: { + "key": "value" + }, + structuredDataMulti: [{ + "key": "value" + }], + successEvaluation: "successEvaluation" + }, + monitor: { + monitors: [{ + monitorId: "monitorId", + filterPassed: true + }], + listenUrl: "listenUrl", + controlUrl: "controlUrl" + }, + artifact: { + messages: [{ + role: "role", message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + messagesOpenAIFormatted: [{ + content: null, + role: "assistant" + }], + skippedStructuredOutputs: { + "key": { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4 + } + } + }, + transfers: [{ + destination: { + type: "number", + number: "number" + } + }], + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ + assistantName: "assistantName" + }], + variableValues: { + "key": "value" + }, + structuredOutputs: { + "key": "value" + }, + scorecards: { + "key": "value" + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt" + }, + compliance: { + recordingConsent: { + type: "stay-on-line" + } + }, + campaignId: "campaignId", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { key: "value" }, - structuredDataMulti: [{ key: "value" }], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [{ monitorId: "monitorId", filterPassed: true }], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - compliance: { recordingConsent: { type: { key: "value" } } }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + target: { + position: -1 + } + }] + } + } + }] + }], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -185,26473 +751,818 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { provider: "openai", model: "gpt-5.4" }, - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [{ from: "from", to: "to" }], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { variableValues: { key: "value" } }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { type: "number", number: "number" }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - transport: { key: "value" }, - subscriptionLimits: { concurrencyBlocked: true, concurrencyLimit: 1.1, remainingConcurrentCalls: 1.1 }, - }, - ]; - - server.mockEndpoint().get("/call").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.calls.list(); - expect(response).toEqual([ - { - type: "inboundPhoneCall", - costs: [ - { - type: "transport", - minutes: 1.1, - cost: 1.1, - }, - ], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { - key: "value", - }, - structuredDataMulti: [ - { - key: "value", - }, - ], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [ - { - monitorId: "monitorId", - filterPassed: true, - }, - ], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", - }, - ], - variableValues: { - key: "value", - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", - }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { - recordingConsent: { - type: { - key: "value", - }, - }, - }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { - provider: "openai", - model: "gpt-5.4", - }, - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [ - { - from: "from", - to: "to", - }, - ], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { - variableValues: { - key: "value", - }, - }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - number: "number", - }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", - }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - transport: { - key: "value", - }, - subscriptionLimits: { - concurrencyBlocked: true, - concurrencyLimit: 1.1, - remainingConcurrentCalls: 1.1, - }, - }, - ]); - }); - - test("create", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - type: "inboundPhoneCall", - costs: [{ type: "transport", provider: "daily", minutes: 1.1, cost: 1.1 }], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { key: "value" }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { key: "value" }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { type: "lastNMessages", maxMessages: 1.1 }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { message: "message" }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true, assistantName: "assistantName", userName: "userName" }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { key: "value" }, - structuredDataMulti: [{ key: "value" }], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [{ monitorId: "monitorId", filterPassed: true }], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { recordingConsent: { type: { key: "value" }, grantedAt: "2024-01-15T09:30:00Z" } }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [{ from: "from", to: "to" }], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { variableValues: { key: "value" } }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", - }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - transport: { key: "value" }, - subscriptionLimits: { concurrencyBlocked: true, concurrencyLimit: 1.1, remainingConcurrentCalls: 1.1 }, - }; - - server - .mockEndpoint() - .post("/call") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.calls.create(); - expect(response).toEqual({ - type: "inboundPhoneCall", - costs: [ - { - type: "transport", - provider: "daily", - minutes: 1.1, - cost: 1.1, - }, - ], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { - key: "value", - }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { - key: "value", - }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { - type: "lastNMessages", - maxMessages: 1.1, - }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { - message: "message", - }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - assistantName: "assistantName", - userName: "userName", - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { - key: "value", - }, - structuredDataMulti: [ - { - key: "value", - }, - ], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [ - { - monitorId: "monitorId", - filterPassed: true, - }, - ], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", - }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", - }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { - recordingConsent: { - type: { - key: "value", - }, - grantedAt: "2024-01-15T09:30:00Z", - }, - }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { - provider: "openai", - model: "gpt-5.4", - temperature: 1.1, - maxTokens: 1.1, - }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [ - { - from: "from", - to: "to", - }, - ], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { - variableValues: { - key: "value", - }, - }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", - }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", - }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - transport: { - key: "value", - }, - subscriptionLimits: { - concurrencyBlocked: true, - concurrencyLimit: 1.1, - remainingConcurrentCalls: 1.1, - }, - }); - }); - - test("get", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - - const rawResponseBody = { - type: "inboundPhoneCall", - costs: [{ type: "transport", provider: "daily", minutes: 1.1, cost: 1.1 }], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { key: "value" }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { key: "value" }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { type: "lastNMessages", maxMessages: 1.1 }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { message: "message" }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true, assistantName: "assistantName", userName: "userName" }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { key: "value" }, - structuredDataMulti: [{ key: "value" }], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [{ monitorId: "monitorId", filterPassed: true }], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { recordingConsent: { type: { key: "value" }, grantedAt: "2024-01-15T09:30:00Z" } }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [{ from: "from", to: "to" }], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { variableValues: { key: "value" } }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", - }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - transport: { key: "value" }, - subscriptionLimits: { concurrencyBlocked: true, concurrencyLimit: 1.1, remainingConcurrentCalls: 1.1 }, - }; - - server.mockEndpoint().get("/call/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.calls.get({ - id: "id", - }); - expect(response).toEqual({ - type: "inboundPhoneCall", - costs: [ - { - type: "transport", - provider: "daily", - minutes: 1.1, - cost: 1.1, - }, - ], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { - key: "value", - }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { - key: "value", - }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { - type: "lastNMessages", - maxMessages: 1.1, - }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { - message: "message", - }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - assistantName: "assistantName", - userName: "userName", - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { - key: "value", - }, - structuredDataMulti: [ - { - key: "value", - }, - ], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [ - { - monitorId: "monitorId", - filterPassed: true, - }, - ], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", - }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", - }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { - recordingConsent: { - type: { - key: "value", - }, - grantedAt: "2024-01-15T09:30:00Z", - }, - }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { - provider: "openai", - model: "gpt-5.4", - temperature: 1.1, - maxTokens: 1.1, - }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [ - { - from: "from", - to: "to", - }, - ], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { - variableValues: { - key: "value", - }, - }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", - }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", - }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - transport: { - key: "value", - }, - subscriptionLimits: { - concurrencyBlocked: true, - concurrencyLimit: 1.1, - remainingConcurrentCalls: 1.1, - }, - }); - }); - - test("delete", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - type: "inboundPhoneCall", - costs: [{ type: "transport", provider: "daily", minutes: 1.1, cost: 1.1 }], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { key: "value" }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { key: "value" }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { type: "lastNMessages", maxMessages: 1.1 }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { message: "message" }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true, assistantName: "assistantName", userName: "userName" }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { key: "value" }, - structuredDataMulti: [{ key: "value" }], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [{ monitorId: "monitorId", filterPassed: true }], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { recordingConsent: { type: { key: "value" }, grantedAt: "2024-01-15T09:30:00Z" } }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadId: "squadId", + squad: { + name: "name", + members: [{ + assistantDestinations: [{ + type: "assistant", + assistantName: "assistantName" + }], + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - }, - model: { - provider: "anthropic", - tools: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - ], + waitSeconds: 3 + } }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - }, - }, - }, - squadOverrides: { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + membersOverrides: { transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -26659,24 +1570,24 @@ describe("CallsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -26685,181 +1596,127 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + target: { + position: -1 + } + }] + } + }], compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -26867,71 +1724,43 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, - metadata: { key: "value" }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { mediaDetectionEnabled: true, staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, - recordingFormat: "wav;l16", recordingUseCustomStorageEnabled: true, videoRecordingEnabled: false, fullMessageHistoryEnabled: false, @@ -26940,595 +1769,428 @@ describe("CallsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - name: "name", - }, - ], - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [{ from: "from", to: "to" }], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, + numberToDigitsCutoff: 2025 + } }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { variableValues: { key: "value" } }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", - }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + workflowId: "workflowId", + workflow: { + nodes: [{ + type: "conversation", transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -27538,71 +2200,16 @@ describe("CallsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", + vadAssistedEndpointingEnabled: true + }] + } }, voice: { provider: "azure", @@ -27611,469 +2218,241 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", + target: { + position: -1 + } + }] + } + }], + name: "name" + }], + model: { + provider: "openai", + model: "gpt-5.6-sol" }, - name: "name", - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - transport: { key: "value" }, - subscriptionLimits: { concurrencyBlocked: true, concurrencyLimit: 1.1, remainingConcurrentCalls: 1.1 }, - }; - - server - .mockEndpoint() - .delete("/call/id") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.calls.delete({ - id: "id", - }); - expect(response).toEqual({ - type: "inboundPhoneCall", - costs: [ - { - type: "transport", - provider: "daily", - minutes: 1.1, - cost: 1.1, - }, - ], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { - key: "value", - }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { - key: "value", - }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { - type: "lastNMessages", - maxMessages: 1.1, - }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { - message: "message", - }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + voicemailDetection: "off", + maxDurationSeconds: 600, + name: "name", + edges: [{ + from: "from", + to: "to" + }], + globalPrompt: "globalPrompt", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } }, artifactPlan: { recordingEnabled: true, - recordingFormat: "wav;l16", recordingUseCustomStorageEnabled: true, videoRecordingEnabled: false, fullMessageHistoryEnabled: false, @@ -28083,212 +2462,174 @@ describe("CallsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, - assistantName: "assistantName", - userName: "userName", + enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", + type: "string" + } + }] }, - analysis: { - summary: "summary", - structuredData: { - key: "value", - }, - structuredDataMulti: [ - { - key: "value", - }, - ], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [ - { - monitorId: "monitorId", - filterPassed: true, - }, - ], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", - }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", - }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - compliance: { - recordingConsent: { - type: { - key: "value", - }, - grantedAt: "2024-01-15T09:30:00Z", - }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } }, - campaignId: "campaignId", + credentialIds: ["credentialIds"], + voicemailMessage: "voicemailMessage" + }, + workflowOverrides: { + variableValues: { + "key": "value" + } + }, + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + number: "number" + }, + hooks: [{ + on: "call.ringing", + "do": [{ + type: "transfer" + }] + }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", assistantId: "assistantId", - assistant: { + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + customerId: "customerId", + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -28297,36 +2638,23 @@ describe("CallsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -28335,186 +2663,127 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -28522,66 +2791,31 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -28589,12 +2823,11 @@ describe("CallsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, - recordingFormat: "wav;l16", recordingUseCustomStorageEnabled: true, videoRecordingEnabled: false, fullMessageHistoryEnabled: false, @@ -28604,238 +2837,131 @@ describe("CallsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - assistantOverrides: { + squadOverrides: { transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -28844,36 +2970,23 @@ describe("CallsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -28882,236 +2995,127 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + position: -1 + } + }] + } + }], compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -29119,66 +3123,31 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -29186,12 +3155,11 @@ describe("CallsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, - recordingFormat: "wav;l16", recordingUseCustomStorageEnabled: true, videoRecordingEnabled: false, fullMessageHistoryEnabled: false, @@ -29201,1143 +3169,1160 @@ describe("CallsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }, + name: "name", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + } + }]); + + + }); + + test("create (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "type" : "inboundPhoneCall" , "costs" : [ { "type" : "transport" , "provider" : "daily" , "minutes" : 1.1 , "cost" : 1.1 } ] , "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 , "duration" : 1.1 , "isFiltered" : true , "detectedThreats" : [ "detectedThreats" ] , "originalMessage" : "originalMessage" , "metadata" : { "key" : "value" } , "speakerLabel" : "speakerLabel" } ] , "phoneCallTransport" : "sip" , "status" : "scheduled" , "endedReason" : "call-start-error-neither-assistant-nor-server-set" , "endedMessage" : "endedMessage" , "destination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" , "message" : "message" , "timeout" : 1.1 , "sipVerb" : { "key" : "value" } , "dialTimeout" : 1.1 , "holdAudioUrl" : "holdAudioUrl" , "transferCompleteAudioUrl" : "transferCompleteAudioUrl" , "contextEngineeringPlan" : { "type" : "lastNMessages" , "maxMessages" : 1.1 } , "twiml" : "twiml" , "sipHeadersInReferToEnabled" : true , "fallbackPlan" : { "message" : "message" } } , "description" : "description" } , "assistantVersion" : "assistantVersion" , "transport" : { "provider" : "vapi.websocket" , "conversationType" : "voice" , "audioFormat" : { "sampleRate" : 1.1 , "format" : { "key" : "value" } , "container" : "raw" } } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "startedAt" : "2024-01-15T09:30:00Z" , "endedAt" : "2024-01-15T09:30:00Z" , "cost" : 1.1 , "costBreakdown" : { "transport" : 1.1 , "stt" : 1.1 , "llm" : 1.1 , "tts" : 1.1 , "vapi" : 1.1 , "chat" : 1.1 , "total" : 1.1 , "llmPromptTokens" : 1.1 , "llmCompletionTokens" : 1.1 , "llmCachedPromptTokens" : 1.1 , "ttsCharacters" : 1.1 , "analysisCostBreakdown" : { "summary" : 1.1 , "summaryPromptTokens" : 1.1 , "summaryCompletionTokens" : 1.1 , "summaryCachedPromptTokens" : 1.1 , "structuredData" : 1.1 , "structuredDataPromptTokens" : 1.1 , "structuredDataCompletionTokens" : 1.1 , "structuredDataCachedPromptTokens" : 1.1 , "successEvaluation" : 1.1 , "successEvaluationPromptTokens" : 1.1 , "successEvaluationCompletionTokens" : 1.1 , "successEvaluationCachedPromptTokens" : 1.1 , "structuredOutput" : 1.1 , "structuredOutputPromptTokens" : 1.1 , "structuredOutputCompletionTokens" : 1.1 , "structuredOutputCachedPromptTokens" : 1.1 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true , "assistantName" : "assistantName" , "userName" : "userName" } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "analysis" : { "summary" : "summary" , "structuredData" : { "key" : "value" } , "structuredDataMulti" : [ { "key" : "value" } ] , "successEvaluation" : "successEvaluation" } , "monitor" : { "monitors" : [ { "monitorId" : "monitorId" , "filterPassed" : true } ] , "listenUrl" : "listenUrl" , "controlUrl" : "controlUrl" } , "artifact" : { "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "messagesOpenAIFormatted" : [ { "content" : null , "role" : "assistant" } ] , "skippedStructuredOutputs" : { "key" : { "name" : "name" , "unmetCondition" : { "type" : "minMessages" , "count" : 4 } } } , "transfers" : [ { "destination" : { "type" : "number" , "number" : "number" } } ] , "recording" : { "stereoUrl" : "stereoUrl" , "videoUrl" : "videoUrl" , "videoRecordingStartDelaySeconds" : 1.1 } , "transcript" : "transcript" , "pcapUrl" : "pcapUrl" , "logUrl" : "logUrl" , "nodes" : [ { } ] , "assistantActivations" : [ { "assistantName" : "assistantName" } ] , "variableValues" : { "key" : "value" } , "performanceMetrics" : { "turnLatencies" : [ { } ] , "modelLatencyAverage" : 1.1 , "voiceLatencyAverage" : 1.1 , "transcriberLatencyAverage" : 1.1 , "endpointingLatencyAverage" : 1.1 , "turnLatencyAverage" : 1.1 , "fromTransportLatencyAverage" : 1.1 , "toTransportLatencyAverage" : 1.1 , "numUserInterrupted" : 1.1 , "numAssistantInterrupted" : 1.1 } , "structuredOutputs" : { "key" : "value" } , "scorecards" : { "key" : "value" } , "structuredOutputsLastUpdatedAt" : "2024-01-15T09:30:00Z" , "presignedMonoUrl" : "presignedMonoUrl" , "presignedStereoUrl" : "presignedStereoUrl" , "presignedVideoUrl" : "presignedVideoUrl" , "presignedAssistantUrl" : "presignedAssistantUrl" , "presignedCustomerUrl" : "presignedCustomerUrl" , "presignedPcapUrl" : "presignedPcapUrl" , "presignedLogUrl" : "presignedLogUrl" , "presignedUrlsExpiresAt" : "presignedUrlsExpiresAt" } , "compliance" : { "recordingConsent" : { "type" : "stay-on-line" , "grantedAt" : "2024-01-15T09:30:00Z" } } , "campaignId" : "campaignId" , "assistantId" : "assistantId" , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadId" : "squadId" , "squad" : { "name" : "name" , "members" : [ { "assistantDestinations" : [ { "type" : "assistant" , "assistantName" : "assistantName" } ] , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "membersOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "workflowId" : "workflowId" , "workflow" : { "nodes" : [ { "type" : "conversation" , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "name" : "name" } ] , "model" : { "provider" : "openai" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "model" : "gpt-5.6-sol" , "temperature" : 1.1 , "maxTokens" : 1.1 } , "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "voicemailDetection" : "off" , "maxDurationSeconds" : 600 , "name" : "name" , "edges" : [ { "from" : "from" , "to" : "to" } ] , "globalPrompt" : "globalPrompt" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "credentialIds" : [ "credentialIds" ] , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } , "voicemailMessage" : "voicemailMessage" } , "workflowOverrides" : { "variableValues" : { "key" : "value" } } , "phoneNumberId" : "phoneNumberId" , "phoneNumber" : { "fallbackDestination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" } , "description" : "description" } , "hooks" : [ { "on" : "call.ringing" , "do" : [ { "type" : "transfer" } ] } ] , "smsEnabled" : true , "twilioPhoneNumber" : "twilioPhoneNumber" , "twilioAccountSid" : "twilioAccountSid" , "twilioAuthToken" : "twilioAuthToken" , "twilioApiKey" : "twilioApiKey" , "twilioApiSecret" : "twilioApiSecret" , "name" : "name" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "customerId" : "customerId" , "customer" : { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } , "name" : "name" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .post("/call").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.calls.create(); + expect(response).toEqual({ + type: "inboundPhoneCall", + costs: [{ + type: "transport", + provider: "daily", + minutes: 1.1, + cost: 1.1 + }], + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + duration: 1.1, + isFiltered: true, + detectedThreats: ["detectedThreats"], + originalMessage: "originalMessage", + metadata: { + "key": "value" + }, + speakerLabel: "speakerLabel" + }], + phoneCallTransport: "sip", + status: "scheduled", + endedReason: "call-start-error-neither-assistant-nor-server-set", + endedMessage: "endedMessage", + destination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + message: "message", + timeout: 1.1, + sipVerb: { + "key": "value" + }, + dialTimeout: 1.1, + holdAudioUrl: "holdAudioUrl", + transferCompleteAudioUrl: "transferCompleteAudioUrl", + contextEngineeringPlan: { + type: "lastNMessages", + maxMessages: 1.1 + }, + twiml: "twiml", + sipHeadersInReferToEnabled: true, + fallbackPlan: { + message: "message" + } + }, + description: "description" + }, + assistantVersion: "assistantVersion", + transport: { + provider: "vapi.websocket", + conversationType: "voice", + audioFormat: { + sampleRate: 1.1, + format: { + "key": "value" + }, + container: "raw" + } + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costBreakdown: { + transport: 1.1, + stt: 1.1, + llm: 1.1, + tts: 1.1, + vapi: 1.1, + chat: 1.1, + total: 1.1, + llmPromptTokens: 1.1, + llmCompletionTokens: 1.1, + llmCachedPromptTokens: 1.1, + ttsCharacters: 1.1, + analysisCostBreakdown: { + summary: 1.1, + summaryPromptTokens: 1.1, + summaryCompletionTokens: 1.1, + summaryCachedPromptTokens: 1.1, + structuredData: 1.1, + structuredDataPromptTokens: 1.1, + structuredDataCompletionTokens: 1.1, + structuredDataCachedPromptTokens: 1.1, + successEvaluation: 1.1, + successEvaluationPromptTokens: 1.1, + successEvaluationCompletionTokens: 1.1, + successEvaluationCachedPromptTokens: 1.1, + structuredOutput: 1.1, + structuredOutputPromptTokens: 1.1, + structuredOutputCompletionTokens: 1.1, + structuredOutputCachedPromptTokens: 1.1 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + assistantName: "assistantName", + userName: "userName" + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + analysis: { + summary: "summary", + structuredData: { + "key": "value" + }, + structuredDataMulti: [{ + "key": "value" + }], + successEvaluation: "successEvaluation" + }, + monitor: { + monitors: [{ + monitorId: "monitorId", + filterPassed: true + }], + listenUrl: "listenUrl", + controlUrl: "controlUrl" + }, + artifact: { + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + messagesOpenAIFormatted: [{ + content: null, + role: "assistant" + }], + skippedStructuredOutputs: { + "key": { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4 + } + } + }, + transfers: [{ + destination: { + type: "number", + number: "number" + } + }], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1 + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ + assistantName: "assistantName" + }], + variableValues: { + "key": "value" + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1 + }, + structuredOutputs: { + "key": "value" + }, + scorecards: { + "key": "value" + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt" + }, + compliance: { + recordingConsent: { + type: "stay-on-line", + grantedAt: "2024-01-15T09:30:00Z" + } + }, + campaignId: "campaignId", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", - headers: { - key: "value", - }, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, + numberToDigitsCutoff: 2025 + } }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - membersOverrides: { + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadId: "squadId", + squad: { + name: "name", + members: [{ + assistantDestinations: [{ + type: "assistant", + assistantName: "assistantName" + }], + assistant: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -30347,68 +4332,55 @@ describe("CallsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -30417,28 +4389,23 @@ describe("CallsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -30447,227 +4414,91 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + position: -1 + } + }] + } + } + }] + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -30675,66 +4506,31 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -30742,8 +4538,8 @@ describe("CallsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -30756,888 +4552,1197 @@ describe("CallsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - ], - tools: [ - { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + numberToDigitsCutoff: 2025 + } }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + waitSeconds: 3 + } }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - tools: [ - { + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - name: "name", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - ], - model: { - provider: "openai", - model: "gpt-5.4", - temperature: 1.1, - maxTokens: 1.1, - }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + workflowId: "workflowId", + workflow: { + nodes: [{ + type: "conversation", transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, voice: { provider: "azure", @@ -31646,562 +5751,656 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [ - { - from: "from", - to: "to", - }, - ], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + name: "name" + }], + model: { + provider: "openai", + messages: [{ + content: null, + role: "assistant" + }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1 + }, + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + voicemailDetection: "off", + maxDurationSeconds: 600, + name: "name", + edges: [{ + from: "from", + to: "to" + }], + globalPrompt: "globalPrompt", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - voicemailMessage: "voicemailMessage", + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - workflowOverrides: { - variableValues: { - key: "value", - }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", - }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + credentialIds: ["credentialIds"], + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + }, + voicemailMessage: "voicemailMessage" + }, + workflowOverrides: { + variableValues: { + "key": "value" + } + }, + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer" + }, + description: "description" + }, + hooks: [{ + on: "call.ringing", + "do": [{ + type: "transfer" + }] + }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + customerId: "customerId", + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -32209,537 +6408,396 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" }, name: "name", - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - transport: { - key: "value", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } }, - subscriptionLimits: { - concurrencyBlocked: true, - concurrencyLimit: 1.1, - remainingConcurrentCalls: 1.1, + metadata: { + "key": "value" }, - }); - }); - - test("update", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - type: "inboundPhoneCall", - costs: [{ type: "transport", provider: "daily", minutes: 1.1, cost: 1.1 }], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { key: "value" }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { key: "value" }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { type: "lastNMessages", maxMessages: 1.1 }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { message: "message" }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, - recordingFormat: "wav;l16", recordingUseCustomStorageEnabled: true, videoRecordingEnabled: false, fullMessageHistoryEnabled: false, @@ -32748,571 +6806,620 @@ describe("CallsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true, assistantName: "assistantName", userName: "userName" }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { compliancePlan: { forceStoreOnHipaaEnabled: false }, name: "name", schema: { type: "string" } }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { key: "value" }, - structuredDataMulti: [{ key: "value" }], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [{ monitorId: "monitorId", filterPassed: true }], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, + transcriptPlan: { + enabled: true }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - compliance: { recordingConsent: { type: { key: "value" }, grantedAt: "2024-01-15T09:30:00Z" } }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }, + name: "name", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("create (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .post("/call").jsonBody(rawRequestBody) + .respondWith() + .statusCode(400).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.create() + }).rejects.toThrow(Vapi.BadRequestError); + }); + + test("create (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .post("/call").jsonBody(rawRequestBody) + .respondWith() + .statusCode(500).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.create() + }).rejects.toThrow(Vapi.InternalServerError); + }); + + test("get", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "type" : "inboundPhoneCall" , "costs" : [ { "type" : "transport" , "provider" : "daily" , "minutes" : 1.1 , "cost" : 1.1 } ] , "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 , "duration" : 1.1 , "isFiltered" : true , "detectedThreats" : [ "detectedThreats" ] , "originalMessage" : "originalMessage" , "metadata" : { "key" : "value" } , "speakerLabel" : "speakerLabel" } ] , "phoneCallTransport" : "sip" , "status" : "scheduled" , "endedReason" : "call-start-error-neither-assistant-nor-server-set" , "endedMessage" : "endedMessage" , "destination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" , "message" : "message" , "timeout" : 1.1 , "sipVerb" : { "key" : "value" } , "dialTimeout" : 1.1 , "holdAudioUrl" : "holdAudioUrl" , "transferCompleteAudioUrl" : "transferCompleteAudioUrl" , "contextEngineeringPlan" : { "type" : "lastNMessages" , "maxMessages" : 1.1 } , "twiml" : "twiml" , "sipHeadersInReferToEnabled" : true , "fallbackPlan" : { "message" : "message" } } , "description" : "description" } , "assistantVersion" : "assistantVersion" , "transport" : { "provider" : "vapi.websocket" , "conversationType" : "voice" , "audioFormat" : { "sampleRate" : 1.1 , "format" : { "key" : "value" } , "container" : "raw" } } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "startedAt" : "2024-01-15T09:30:00Z" , "endedAt" : "2024-01-15T09:30:00Z" , "cost" : 1.1 , "costBreakdown" : { "transport" : 1.1 , "stt" : 1.1 , "llm" : 1.1 , "tts" : 1.1 , "vapi" : 1.1 , "chat" : 1.1 , "total" : 1.1 , "llmPromptTokens" : 1.1 , "llmCompletionTokens" : 1.1 , "llmCachedPromptTokens" : 1.1 , "ttsCharacters" : 1.1 , "analysisCostBreakdown" : { "summary" : 1.1 , "summaryPromptTokens" : 1.1 , "summaryCompletionTokens" : 1.1 , "summaryCachedPromptTokens" : 1.1 , "structuredData" : 1.1 , "structuredDataPromptTokens" : 1.1 , "structuredDataCompletionTokens" : 1.1 , "structuredDataCachedPromptTokens" : 1.1 , "successEvaluation" : 1.1 , "successEvaluationPromptTokens" : 1.1 , "successEvaluationCompletionTokens" : 1.1 , "successEvaluationCachedPromptTokens" : 1.1 , "structuredOutput" : 1.1 , "structuredOutputPromptTokens" : 1.1 , "structuredOutputCompletionTokens" : 1.1 , "structuredOutputCachedPromptTokens" : 1.1 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true , "assistantName" : "assistantName" , "userName" : "userName" } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "analysis" : { "summary" : "summary" , "structuredData" : { "key" : "value" } , "structuredDataMulti" : [ { "key" : "value" } ] , "successEvaluation" : "successEvaluation" } , "monitor" : { "monitors" : [ { "monitorId" : "monitorId" , "filterPassed" : true } ] , "listenUrl" : "listenUrl" , "controlUrl" : "controlUrl" } , "artifact" : { "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "messagesOpenAIFormatted" : [ { "content" : null , "role" : "assistant" } ] , "skippedStructuredOutputs" : { "key" : { "name" : "name" , "unmetCondition" : { "type" : "minMessages" , "count" : 4 } } } , "transfers" : [ { "destination" : { "type" : "number" , "number" : "number" } } ] , "recording" : { "stereoUrl" : "stereoUrl" , "videoUrl" : "videoUrl" , "videoRecordingStartDelaySeconds" : 1.1 } , "transcript" : "transcript" , "pcapUrl" : "pcapUrl" , "logUrl" : "logUrl" , "nodes" : [ { } ] , "assistantActivations" : [ { "assistantName" : "assistantName" } ] , "variableValues" : { "key" : "value" } , "performanceMetrics" : { "turnLatencies" : [ { } ] , "modelLatencyAverage" : 1.1 , "voiceLatencyAverage" : 1.1 , "transcriberLatencyAverage" : 1.1 , "endpointingLatencyAverage" : 1.1 , "turnLatencyAverage" : 1.1 , "fromTransportLatencyAverage" : 1.1 , "toTransportLatencyAverage" : 1.1 , "numUserInterrupted" : 1.1 , "numAssistantInterrupted" : 1.1 } , "structuredOutputs" : { "key" : "value" } , "scorecards" : { "key" : "value" } , "structuredOutputsLastUpdatedAt" : "2024-01-15T09:30:00Z" , "presignedMonoUrl" : "presignedMonoUrl" , "presignedStereoUrl" : "presignedStereoUrl" , "presignedVideoUrl" : "presignedVideoUrl" , "presignedAssistantUrl" : "presignedAssistantUrl" , "presignedCustomerUrl" : "presignedCustomerUrl" , "presignedPcapUrl" : "presignedPcapUrl" , "presignedLogUrl" : "presignedLogUrl" , "presignedUrlsExpiresAt" : "presignedUrlsExpiresAt" } , "compliance" : { "recordingConsent" : { "type" : "stay-on-line" , "grantedAt" : "2024-01-15T09:30:00Z" } } , "campaignId" : "campaignId" , "assistantId" : "assistantId" , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadId" : "squadId" , "squad" : { "name" : "name" , "members" : [ { "assistantDestinations" : [ { "type" : "assistant" , "assistantName" : "assistantName" } ] , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "membersOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "workflowId" : "workflowId" , "workflow" : { "nodes" : [ { "type" : "conversation" , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "name" : "name" } ] , "model" : { "provider" : "openai" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "model" : "gpt-5.6-sol" , "temperature" : 1.1 , "maxTokens" : 1.1 } , "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "voicemailDetection" : "off" , "maxDurationSeconds" : 600 , "name" : "name" , "edges" : [ { "from" : "from" , "to" : "to" } ] , "globalPrompt" : "globalPrompt" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "credentialIds" : [ "credentialIds" ] , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } , "voicemailMessage" : "voicemailMessage" } , "workflowOverrides" : { "variableValues" : { "key" : "value" } } , "phoneNumberId" : "phoneNumberId" , "phoneNumber" : { "fallbackDestination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" } , "description" : "description" } , "hooks" : [ { "on" : "call.ringing" , "do" : [ { "type" : "transfer" } ] } ] , "smsEnabled" : true , "twilioPhoneNumber" : "twilioPhoneNumber" , "twilioAccountSid" : "twilioAccountSid" , "twilioAuthToken" : "twilioAuthToken" , "twilioApiKey" : "twilioApiKey" , "twilioApiSecret" : "twilioApiSecret" , "name" : "name" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "customerId" : "customerId" , "customer" : { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } , "name" : "name" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .get("/call/id").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.calls.get({ + id: "id" +}); + expect(response).toEqual({ + type: "inboundPhoneCall", + costs: [{ + type: "transport", + provider: "daily", + minutes: 1.1, + cost: 1.1 + }], + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + duration: 1.1, + isFiltered: true, + detectedThreats: ["detectedThreats"], + originalMessage: "originalMessage", + metadata: { + "key": "value" + }, + speakerLabel: "speakerLabel" + }], + phoneCallTransport: "sip", + status: "scheduled", + endedReason: "call-start-error-neither-assistant-nor-server-set", + endedMessage: "endedMessage", + destination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + message: "message", + timeout: 1.1, + sipVerb: { + "key": "value" + }, + dialTimeout: 1.1, + holdAudioUrl: "holdAudioUrl", + transferCompleteAudioUrl: "transferCompleteAudioUrl", + contextEngineeringPlan: { + type: "lastNMessages", + maxMessages: 1.1 + }, + twiml: "twiml", + sipHeadersInReferToEnabled: true, + fallbackPlan: { + message: "message" + } + }, + description: "description" + }, + assistantVersion: "assistantVersion", + transport: { + provider: "vapi.websocket", + conversationType: "voice", + audioFormat: { + sampleRate: 1.1, + format: { + "key": "value" + }, + container: "raw" + } + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costBreakdown: { + transport: 1.1, + stt: 1.1, + llm: 1.1, + tts: 1.1, + vapi: 1.1, + chat: 1.1, + total: 1.1, + llmPromptTokens: 1.1, + llmCompletionTokens: 1.1, + llmCachedPromptTokens: 1.1, + ttsCharacters: 1.1, + analysisCostBreakdown: { + summary: 1.1, + summaryPromptTokens: 1.1, + summaryCompletionTokens: 1.1, + summaryCachedPromptTokens: 1.1, + structuredData: 1.1, + structuredDataPromptTokens: 1.1, + structuredDataCompletionTokens: 1.1, + structuredDataCachedPromptTokens: 1.1, + successEvaluation: 1.1, + successEvaluationPromptTokens: 1.1, + successEvaluationCompletionTokens: 1.1, + successEvaluationCachedPromptTokens: 1.1, + structuredOutput: 1.1, + structuredOutputPromptTokens: 1.1, + structuredOutputCompletionTokens: 1.1, + structuredOutputCachedPromptTokens: 1.1 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + assistantName: "assistantName", + userName: "userName" + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + analysis: { + summary: "summary", + structuredData: { + "key": "value" + }, + structuredDataMulti: [{ + "key": "value" + }], + successEvaluation: "successEvaluation" + }, + monitor: { + monitors: [{ + monitorId: "monitorId", + filterPassed: true + }], + listenUrl: "listenUrl", + controlUrl: "controlUrl" + }, + artifact: { + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + messagesOpenAIFormatted: [{ + content: null, + role: "assistant" + }], + skippedStructuredOutputs: { + "key": { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4 + } + } + }, + transfers: [{ + destination: { + type: "number", + number: "number" + } + }], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1 + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ + assistantName: "assistantName" + }], + variableValues: { + "key": "value" + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1 + }, + structuredOutputs: { + "key": "value" + }, + scorecards: { + "key": "value" + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt" + }, + compliance: { + recordingConsent: { + type: "stay-on-line", + grantedAt: "2024-01-15T09:30:00Z" + } + }, + campaignId: "campaignId", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, + target: { + position: -1 + } + }] + } + } + }] + }], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -33320,1161 +7427,876 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadId: "squadId", + squad: { + name: "name", + members: [{ + assistantDestinations: [{ + type: "assistant", + assistantName: "assistantName" + }], + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, + target: { + position: -1 + } + }] + } + } + }] + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - ], - membersOverrides: { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -34484,51 +8306,55 @@ describe("CallsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -34536,19 +8362,24 @@ describe("CallsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -34557,171 +8388,127 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + target: { + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -34729,67 +8516,40 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, - metadata: { key: "value" }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { mediaDetectionEnabled: true, staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -34801,191 +8561,1105 @@ describe("CallsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - squadOverrides: { + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + workflowId: "workflowId", + workflow: { + nodes: [{ + type: "conversation", transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + name: "name" + }], + model: { + provider: "openai", + messages: [{ + content: null, + role: "assistant" + }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1 + }, + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, + target: { + position: -1 + } + }] + } + } + }] + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + voicemailDetection: "off", + maxDurationSeconds: 600, + name: "name", + edges: [{ + from: "from", + to: "to" + }], + globalPrompt: "globalPrompt", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -34993,508 +9667,1400 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + credentialIds: ["credentialIds"], + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + }, + voicemailMessage: "voicemailMessage" + }, + workflowOverrides: { + variableValues: { + "key": "value" + } + }, + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer" + }, + description: "description" + }, + hooks: [{ + on: "call.ringing", + "do": [{ + type: "transfer" + }] + }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + customerId: "customerId", + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - credentialIds: ["credentialIds"], - server: { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - tools: [ - { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - }, - ], - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }, + name: "name", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("delete (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "type" : "inboundPhoneCall" , "costs" : [ { "type" : "transport" , "provider" : "daily" , "minutes" : 1.1 , "cost" : 1.1 } ] , "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 , "duration" : 1.1 , "isFiltered" : true , "detectedThreats" : [ "detectedThreats" ] , "originalMessage" : "originalMessage" , "metadata" : { "key" : "value" } , "speakerLabel" : "speakerLabel" } ] , "phoneCallTransport" : "sip" , "status" : "scheduled" , "endedReason" : "call-start-error-neither-assistant-nor-server-set" , "endedMessage" : "endedMessage" , "destination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" , "message" : "message" , "timeout" : 1.1 , "sipVerb" : { "key" : "value" } , "dialTimeout" : 1.1 , "holdAudioUrl" : "holdAudioUrl" , "transferCompleteAudioUrl" : "transferCompleteAudioUrl" , "contextEngineeringPlan" : { "type" : "lastNMessages" , "maxMessages" : 1.1 } , "twiml" : "twiml" , "sipHeadersInReferToEnabled" : true , "fallbackPlan" : { "message" : "message" } } , "description" : "description" } , "assistantVersion" : "assistantVersion" , "transport" : { "provider" : "vapi.websocket" , "conversationType" : "voice" , "audioFormat" : { "sampleRate" : 1.1 , "format" : { "key" : "value" } , "container" : "raw" } } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "startedAt" : "2024-01-15T09:30:00Z" , "endedAt" : "2024-01-15T09:30:00Z" , "cost" : 1.1 , "costBreakdown" : { "transport" : 1.1 , "stt" : 1.1 , "llm" : 1.1 , "tts" : 1.1 , "vapi" : 1.1 , "chat" : 1.1 , "total" : 1.1 , "llmPromptTokens" : 1.1 , "llmCompletionTokens" : 1.1 , "llmCachedPromptTokens" : 1.1 , "ttsCharacters" : 1.1 , "analysisCostBreakdown" : { "summary" : 1.1 , "summaryPromptTokens" : 1.1 , "summaryCompletionTokens" : 1.1 , "summaryCachedPromptTokens" : 1.1 , "structuredData" : 1.1 , "structuredDataPromptTokens" : 1.1 , "structuredDataCompletionTokens" : 1.1 , "structuredDataCachedPromptTokens" : 1.1 , "successEvaluation" : 1.1 , "successEvaluationPromptTokens" : 1.1 , "successEvaluationCompletionTokens" : 1.1 , "successEvaluationCachedPromptTokens" : 1.1 , "structuredOutput" : 1.1 , "structuredOutputPromptTokens" : 1.1 , "structuredOutputCompletionTokens" : 1.1 , "structuredOutputCachedPromptTokens" : 1.1 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true , "assistantName" : "assistantName" , "userName" : "userName" } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "analysis" : { "summary" : "summary" , "structuredData" : { "key" : "value" } , "structuredDataMulti" : [ { "key" : "value" } ] , "successEvaluation" : "successEvaluation" } , "monitor" : { "monitors" : [ { "monitorId" : "monitorId" , "filterPassed" : true } ] , "listenUrl" : "listenUrl" , "controlUrl" : "controlUrl" } , "artifact" : { "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "messagesOpenAIFormatted" : [ { "content" : null , "role" : "assistant" } ] , "skippedStructuredOutputs" : { "key" : { "name" : "name" , "unmetCondition" : { "type" : "minMessages" , "count" : 4 } } } , "transfers" : [ { "destination" : { "type" : "number" , "number" : "number" } } ] , "recording" : { "stereoUrl" : "stereoUrl" , "videoUrl" : "videoUrl" , "videoRecordingStartDelaySeconds" : 1.1 } , "transcript" : "transcript" , "pcapUrl" : "pcapUrl" , "logUrl" : "logUrl" , "nodes" : [ { } ] , "assistantActivations" : [ { "assistantName" : "assistantName" } ] , "variableValues" : { "key" : "value" } , "performanceMetrics" : { "turnLatencies" : [ { } ] , "modelLatencyAverage" : 1.1 , "voiceLatencyAverage" : 1.1 , "transcriberLatencyAverage" : 1.1 , "endpointingLatencyAverage" : 1.1 , "turnLatencyAverage" : 1.1 , "fromTransportLatencyAverage" : 1.1 , "toTransportLatencyAverage" : 1.1 , "numUserInterrupted" : 1.1 , "numAssistantInterrupted" : 1.1 } , "structuredOutputs" : { "key" : "value" } , "scorecards" : { "key" : "value" } , "structuredOutputsLastUpdatedAt" : "2024-01-15T09:30:00Z" , "presignedMonoUrl" : "presignedMonoUrl" , "presignedStereoUrl" : "presignedStereoUrl" , "presignedVideoUrl" : "presignedVideoUrl" , "presignedAssistantUrl" : "presignedAssistantUrl" , "presignedCustomerUrl" : "presignedCustomerUrl" , "presignedPcapUrl" : "presignedPcapUrl" , "presignedLogUrl" : "presignedLogUrl" , "presignedUrlsExpiresAt" : "presignedUrlsExpiresAt" } , "compliance" : { "recordingConsent" : { "type" : "stay-on-line" , "grantedAt" : "2024-01-15T09:30:00Z" } } , "campaignId" : "campaignId" , "assistantId" : "assistantId" , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadId" : "squadId" , "squad" : { "name" : "name" , "members" : [ { "assistantDestinations" : [ { "type" : "assistant" , "assistantName" : "assistantName" } ] , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "membersOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "workflowId" : "workflowId" , "workflow" : { "nodes" : [ { "type" : "conversation" , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "name" : "name" } ] , "model" : { "provider" : "openai" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "model" : "gpt-5.6-sol" , "temperature" : 1.1 , "maxTokens" : 1.1 } , "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "voicemailDetection" : "off" , "maxDurationSeconds" : 600 , "name" : "name" , "edges" : [ { "from" : "from" , "to" : "to" } ] , "globalPrompt" : "globalPrompt" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "credentialIds" : [ "credentialIds" ] , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } , "voicemailMessage" : "voicemailMessage" } , "workflowOverrides" : { "variableValues" : { "key" : "value" } } , "phoneNumberId" : "phoneNumberId" , "phoneNumber" : { "fallbackDestination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" } , "description" : "description" } , "hooks" : [ { "on" : "call.ringing" , "do" : [ { "type" : "transfer" } ] } ] , "smsEnabled" : true , "twilioPhoneNumber" : "twilioPhoneNumber" , "twilioAccountSid" : "twilioAccountSid" , "twilioAuthToken" : "twilioAuthToken" , "twilioApiKey" : "twilioApiKey" , "twilioApiSecret" : "twilioApiSecret" , "name" : "name" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "customerId" : "customerId" , "customer" : { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } , "name" : "name" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .delete("/call/id").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.calls.delete({ + id: "id" +}); + expect(response).toEqual({ + type: "inboundPhoneCall", + costs: [{ + type: "transport", + provider: "daily", + minutes: 1.1, + cost: 1.1 + }], + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + duration: 1.1, + isFiltered: true, + detectedThreats: ["detectedThreats"], + originalMessage: "originalMessage", + metadata: { + "key": "value" + }, + speakerLabel: "speakerLabel" + }], + phoneCallTransport: "sip", + status: "scheduled", + endedReason: "call-start-error-neither-assistant-nor-server-set", + endedMessage: "endedMessage", + destination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + message: "message", + timeout: 1.1, + sipVerb: { + "key": "value" + }, + dialTimeout: 1.1, + holdAudioUrl: "holdAudioUrl", + transferCompleteAudioUrl: "transferCompleteAudioUrl", + contextEngineeringPlan: { + type: "lastNMessages", + maxMessages: 1.1 + }, + twiml: "twiml", + sipHeadersInReferToEnabled: true, + fallbackPlan: { + message: "message" + } + }, + description: "description" + }, + assistantVersion: "assistantVersion", + transport: { + provider: "vapi.websocket", + conversationType: "voice", + audioFormat: { + sampleRate: 1.1, + format: { + "key": "value" + }, + container: "raw" + } + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costBreakdown: { + transport: 1.1, + stt: 1.1, + llm: 1.1, + tts: 1.1, + vapi: 1.1, + chat: 1.1, + total: 1.1, + llmPromptTokens: 1.1, + llmCompletionTokens: 1.1, + llmCachedPromptTokens: 1.1, + ttsCharacters: 1.1, + analysisCostBreakdown: { + summary: 1.1, + summaryPromptTokens: 1.1, + summaryCompletionTokens: 1.1, + summaryCachedPromptTokens: 1.1, + structuredData: 1.1, + structuredDataPromptTokens: 1.1, + structuredDataCompletionTokens: 1.1, + structuredDataCachedPromptTokens: 1.1, + successEvaluation: 1.1, + successEvaluationPromptTokens: 1.1, + successEvaluationCompletionTokens: 1.1, + successEvaluationCachedPromptTokens: 1.1, + structuredOutput: 1.1, + structuredOutputPromptTokens: 1.1, + structuredOutputCompletionTokens: 1.1, + structuredOutputCachedPromptTokens: 1.1 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + assistantName: "assistantName", + userName: "userName" + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + analysis: { + summary: "summary", + structuredData: { + "key": "value" + }, + structuredDataMulti: [{ + "key": "value" + }], + successEvaluation: "successEvaluation" + }, + monitor: { + monitors: [{ + monitorId: "monitorId", + filterPassed: true + }], + listenUrl: "listenUrl", + controlUrl: "controlUrl" + }, + artifact: { + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + messagesOpenAIFormatted: [{ + content: null, + role: "assistant" + }], + skippedStructuredOutputs: { + "key": { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4 + } + } + }, + transfers: [{ + destination: { + type: "number", + number: "number" + } + }], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1 + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ + assistantName: "assistantName" + }], + variableValues: { + "key": "value" + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1 + }, + structuredOutputs: { + "key": "value" + }, + scorecards: { + "key": "value" + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt" + }, + compliance: { + recordingConsent: { + type: "stay-on-line", + grantedAt: "2024-01-15T09:30:00Z" + } + }, + campaignId: "campaignId", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -35502,341 +11068,580 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [{ from: "from", to: "to" }], - globalPrompt: "globalPrompt", - server: { + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - voicemailMessage: "voicemailMessage", - }, - workflowOverrides: { variableValues: { key: "value" } }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", - }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadId: "squadId", + squad: { + name: "name", + members: [{ + assistantDestinations: [{ + type: "assistant", + assistantName: "assistantName" + }], + assistant: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -35846,51 +11651,55 @@ describe("CallsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -35898,19 +11707,24 @@ describe("CallsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -35919,171 +11733,91 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -36091,67 +11825,40 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, - metadata: { key: "value" }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { mediaDetectionEnabled: true, staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -36163,2077 +11870,3616 @@ describe("CallsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - name: "name", - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - transport: { key: "value" }, - subscriptionLimits: { concurrencyBlocked: true, concurrencyLimit: 1.1, remainingConcurrentCalls: 1.1 }, - }; - - server - .mockEndpoint() - .patch("/call/id") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.calls.update({ - id: "id", - }); - expect(response).toEqual({ - type: "inboundPhoneCall", - costs: [ - { - type: "transport", - provider: "daily", - minutes: 1.1, - cost: 1.1, - }, - ], - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - duration: 1.1, - isFiltered: true, - detectedThreats: ["detectedThreats"], - originalMessage: "originalMessage", - metadata: { - key: "value", - }, - speakerLabel: "speakerLabel", - }, - ], - phoneCallTransport: "sip", - status: "scheduled", - endedReason: "call-start-error-neither-assistant-nor-server-set", - endedMessage: "endedMessage", - destination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - message: "message", - timeout: 1.1, - sipVerb: { - key: "value", - }, - dialTimeout: 1.1, - holdAudioUrl: "holdAudioUrl", - transferCompleteAudioUrl: "transferCompleteAudioUrl", - contextEngineeringPlan: { - type: "lastNMessages", - maxMessages: 1.1, - }, - twiml: "twiml", - sipHeadersInReferToEnabled: true, - fallbackPlan: { - message: "message", - }, - }, - description: "description", - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - startedAt: "2024-01-15T09:30:00Z", - endedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costBreakdown: { - transport: 1.1, - stt: 1.1, - llm: 1.1, - tts: 1.1, - vapi: 1.1, - chat: 1.1, - total: 1.1, - llmPromptTokens: 1.1, - llmCompletionTokens: 1.1, - llmCachedPromptTokens: 1.1, - ttsCharacters: 1.1, - analysisCostBreakdown: { - summary: 1.1, - summaryPromptTokens: 1.1, - summaryCompletionTokens: 1.1, - summaryCachedPromptTokens: 1.1, - structuredData: 1.1, - structuredDataPromptTokens: 1.1, - structuredDataCompletionTokens: 1.1, - structuredDataCachedPromptTokens: 1.1, - successEvaluation: 1.1, - successEvaluationPromptTokens: 1.1, - successEvaluationCompletionTokens: 1.1, - successEvaluationCachedPromptTokens: 1.1, - structuredOutput: 1.1, - structuredOutputPromptTokens: 1.1, - structuredOutputCompletionTokens: 1.1, - structuredOutputCachedPromptTokens: 1.1, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - assistantName: "assistantName", - userName: "userName", - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - analysis: { - summary: "summary", - structuredData: { - key: "value", - }, - structuredDataMulti: [ - { - key: "value", - }, - ], - successEvaluation: "successEvaluation", - }, - monitor: { - monitors: [ - { - monitorId: "monitorId", - filterPassed: true, - }, - ], - listenUrl: "listenUrl", - controlUrl: "controlUrl", - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", - }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", - }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - compliance: { - recordingConsent: { - type: { - key: "value", - }, - grantedAt: "2024-01-15T09:30:00Z", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - }, - campaignId: "campaignId", - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - ], + waitSeconds: 3 + } }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - ], - loggingPath: "loggingPath", + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - assistantOverrides: { + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + workflowId: "workflowId", + workflow: { + nodes: [{ + type: "conversation", transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - tools: [ - { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + name: "name" + }], + model: { + provider: "openai", + messages: [{ + content: null, + role: "assistant" + }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1 + }, + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], + position: -1 + } + }] + } + } + }] + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + voicemailDetection: "off", + maxDurationSeconds: 600, + name: "name", + edges: [{ + from: "from", + to: "to" + }], + globalPrompt: "globalPrompt", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + credentialIds: ["credentialIds"], + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + }, + voicemailMessage: "voicemailMessage" + }, + workflowOverrides: { + variableValues: { + "key": "value" + } + }, + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer" + }, + description: "description" + }, + hooks: [{ + on: "call.ringing", + "do": [{ + type: "transfer" + }] + }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + customerId: "customerId", + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }, + name: "name", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("delete (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .delete("/call/id").jsonBody(rawRequestBody) + .respondWith() + .statusCode(503).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.delete({ + id: "id" +}) + }).rejects.toThrow(Vapi.ServiceUnavailableError); + }); + + test("update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "type" : "inboundPhoneCall" , "costs" : [ { "type" : "transport" , "provider" : "daily" , "minutes" : 1.1 , "cost" : 1.1 } ] , "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 , "duration" : 1.1 , "isFiltered" : true , "detectedThreats" : [ "detectedThreats" ] , "originalMessage" : "originalMessage" , "metadata" : { "key" : "value" } , "speakerLabel" : "speakerLabel" } ] , "phoneCallTransport" : "sip" , "status" : "scheduled" , "endedReason" : "call-start-error-neither-assistant-nor-server-set" , "endedMessage" : "endedMessage" , "destination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" , "message" : "message" , "timeout" : 1.1 , "sipVerb" : { "key" : "value" } , "dialTimeout" : 1.1 , "holdAudioUrl" : "holdAudioUrl" , "transferCompleteAudioUrl" : "transferCompleteAudioUrl" , "contextEngineeringPlan" : { "type" : "lastNMessages" , "maxMessages" : 1.1 } , "twiml" : "twiml" , "sipHeadersInReferToEnabled" : true , "fallbackPlan" : { "message" : "message" } } , "description" : "description" } , "assistantVersion" : "assistantVersion" , "transport" : { "provider" : "vapi.websocket" , "conversationType" : "voice" , "audioFormat" : { "sampleRate" : 1.1 , "format" : { "key" : "value" } , "container" : "raw" } } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "startedAt" : "2024-01-15T09:30:00Z" , "endedAt" : "2024-01-15T09:30:00Z" , "cost" : 1.1 , "costBreakdown" : { "transport" : 1.1 , "stt" : 1.1 , "llm" : 1.1 , "tts" : 1.1 , "vapi" : 1.1 , "chat" : 1.1 , "total" : 1.1 , "llmPromptTokens" : 1.1 , "llmCompletionTokens" : 1.1 , "llmCachedPromptTokens" : 1.1 , "ttsCharacters" : 1.1 , "analysisCostBreakdown" : { "summary" : 1.1 , "summaryPromptTokens" : 1.1 , "summaryCompletionTokens" : 1.1 , "summaryCachedPromptTokens" : 1.1 , "structuredData" : 1.1 , "structuredDataPromptTokens" : 1.1 , "structuredDataCompletionTokens" : 1.1 , "structuredDataCachedPromptTokens" : 1.1 , "successEvaluation" : 1.1 , "successEvaluationPromptTokens" : 1.1 , "successEvaluationCompletionTokens" : 1.1 , "successEvaluationCachedPromptTokens" : 1.1 , "structuredOutput" : 1.1 , "structuredOutputPromptTokens" : 1.1 , "structuredOutputCompletionTokens" : 1.1 , "structuredOutputCachedPromptTokens" : 1.1 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true , "assistantName" : "assistantName" , "userName" : "userName" } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "analysis" : { "summary" : "summary" , "structuredData" : { "key" : "value" } , "structuredDataMulti" : [ { "key" : "value" } ] , "successEvaluation" : "successEvaluation" } , "monitor" : { "monitors" : [ { "monitorId" : "monitorId" , "filterPassed" : true } ] , "listenUrl" : "listenUrl" , "controlUrl" : "controlUrl" } , "artifact" : { "messages" : [ { "role" : "role" , "message" : "message" , "time" : 1.1 , "endTime" : 1.1 , "secondsFromStart" : 1.1 } ] , "messagesOpenAIFormatted" : [ { "content" : null , "role" : "assistant" } ] , "skippedStructuredOutputs" : { "key" : { "name" : "name" , "unmetCondition" : { "type" : "minMessages" , "count" : 4 } } } , "transfers" : [ { "destination" : { "type" : "number" , "number" : "number" } } ] , "recording" : { "stereoUrl" : "stereoUrl" , "videoUrl" : "videoUrl" , "videoRecordingStartDelaySeconds" : 1.1 } , "transcript" : "transcript" , "pcapUrl" : "pcapUrl" , "logUrl" : "logUrl" , "nodes" : [ { } ] , "assistantActivations" : [ { "assistantName" : "assistantName" } ] , "variableValues" : { "key" : "value" } , "performanceMetrics" : { "turnLatencies" : [ { } ] , "modelLatencyAverage" : 1.1 , "voiceLatencyAverage" : 1.1 , "transcriberLatencyAverage" : 1.1 , "endpointingLatencyAverage" : 1.1 , "turnLatencyAverage" : 1.1 , "fromTransportLatencyAverage" : 1.1 , "toTransportLatencyAverage" : 1.1 , "numUserInterrupted" : 1.1 , "numAssistantInterrupted" : 1.1 } , "structuredOutputs" : { "key" : "value" } , "scorecards" : { "key" : "value" } , "structuredOutputsLastUpdatedAt" : "2024-01-15T09:30:00Z" , "presignedMonoUrl" : "presignedMonoUrl" , "presignedStereoUrl" : "presignedStereoUrl" , "presignedVideoUrl" : "presignedVideoUrl" , "presignedAssistantUrl" : "presignedAssistantUrl" , "presignedCustomerUrl" : "presignedCustomerUrl" , "presignedPcapUrl" : "presignedPcapUrl" , "presignedLogUrl" : "presignedLogUrl" , "presignedUrlsExpiresAt" : "presignedUrlsExpiresAt" } , "compliance" : { "recordingConsent" : { "type" : "stay-on-line" , "grantedAt" : "2024-01-15T09:30:00Z" } } , "campaignId" : "campaignId" , "assistantId" : "assistantId" , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadId" : "squadId" , "squad" : { "name" : "name" , "members" : [ { "assistantDestinations" : [ { "type" : "assistant" , "assistantName" : "assistantName" } ] , "assistant" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "membersOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "workflowId" : "workflowId" , "workflow" : { "nodes" : [ { "type" : "conversation" , "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "name" : "name" } ] , "model" : { "provider" : "openai" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "model" : "gpt-5.6-sol" , "temperature" : 1.1 , "maxTokens" : 1.1 } , "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "voicemailDetection" : "off" , "maxDurationSeconds" : 600 , "name" : "name" , "edges" : [ { "from" : "from" , "to" : "to" } ] , "globalPrompt" : "globalPrompt" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "credentialIds" : [ "credentialIds" ] , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } , "voicemailMessage" : "voicemailMessage" } , "workflowOverrides" : { "variableValues" : { "key" : "value" } } , "phoneNumberId" : "phoneNumberId" , "phoneNumber" : { "fallbackDestination" : { "type" : "number" , "message" : "message" , "numberE164CheckEnabled" : true , "number" : "number" , "extension" : "extension" , "callerId" : "callerId" , "transferPlan" : { "mode" : "blind-transfer" } , "description" : "description" } , "hooks" : [ { "on" : "call.ringing" , "do" : [ { "type" : "transfer" } ] } ] , "smsEnabled" : true , "twilioPhoneNumber" : "twilioPhoneNumber" , "twilioAccountSid" : "twilioAccountSid" , "twilioAuthToken" : "twilioAuthToken" , "twilioApiKey" : "twilioApiKey" , "twilioApiSecret" : "twilioApiSecret" , "name" : "name" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "customerId" : "customerId" , "customer" : { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "tags" : [ "tags" ] } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } , "name" : "name" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .patch("/call/id").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.calls.update({ + id: "id" +}); + expect(response).toEqual({ + type: "inboundPhoneCall", + costs: [{ + type: "transport", + provider: "daily", + minutes: 1.1, + cost: 1.1 + }], + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + duration: 1.1, + isFiltered: true, + detectedThreats: ["detectedThreats"], + originalMessage: "originalMessage", + metadata: { + "key": "value" + }, + speakerLabel: "speakerLabel" + }], + phoneCallTransport: "sip", + status: "scheduled", + endedReason: "call-start-error-neither-assistant-nor-server-set", + endedMessage: "endedMessage", + destination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + message: "message", + timeout: 1.1, + sipVerb: { + "key": "value" + }, + dialTimeout: 1.1, + holdAudioUrl: "holdAudioUrl", + transferCompleteAudioUrl: "transferCompleteAudioUrl", + contextEngineeringPlan: { + type: "lastNMessages", + maxMessages: 1.1 + }, + twiml: "twiml", + sipHeadersInReferToEnabled: true, + fallbackPlan: { + message: "message" + } + }, + description: "description" + }, + assistantVersion: "assistantVersion", + transport: { + provider: "vapi.websocket", + conversationType: "voice", + audioFormat: { + sampleRate: 1.1, + format: { + "key": "value" + }, + container: "raw" + } + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costBreakdown: { + transport: 1.1, + stt: 1.1, + llm: 1.1, + tts: 1.1, + vapi: 1.1, + chat: 1.1, + total: 1.1, + llmPromptTokens: 1.1, + llmCompletionTokens: 1.1, + llmCachedPromptTokens: 1.1, + ttsCharacters: 1.1, + analysisCostBreakdown: { + summary: 1.1, + summaryPromptTokens: 1.1, + summaryCompletionTokens: 1.1, + summaryCachedPromptTokens: 1.1, + structuredData: 1.1, + structuredDataPromptTokens: 1.1, + structuredDataCompletionTokens: 1.1, + structuredDataCachedPromptTokens: 1.1, + successEvaluation: 1.1, + successEvaluationPromptTokens: 1.1, + successEvaluationCompletionTokens: 1.1, + successEvaluationCachedPromptTokens: 1.1, + structuredOutput: 1.1, + structuredOutputPromptTokens: 1.1, + structuredOutputCompletionTokens: 1.1, + structuredOutputCachedPromptTokens: 1.1 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + assistantName: "assistantName", + userName: "userName" + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + analysis: { + summary: "summary", + structuredData: { + "key": "value" + }, + structuredDataMulti: [{ + "key": "value" + }], + successEvaluation: "successEvaluation" + }, + monitor: { + monitors: [{ + monitorId: "monitorId", + filterPassed: true + }], + listenUrl: "listenUrl", + controlUrl: "controlUrl" + }, + artifact: { + messages: [{ + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1 + }], + messagesOpenAIFormatted: [{ + content: null, + role: "assistant" + }], + skippedStructuredOutputs: { + "key": { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4 + } + } + }, + transfers: [{ + destination: { + type: "number", + number: "number" + } + }], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1 + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ + assistantName: "assistantName" + }], + variableValues: { + "key": "value" + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1 + }, + structuredOutputs: { + "key": "value" + }, + scorecards: { + "key": "value" + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt" + }, + compliance: { + recordingConsent: { + type: "stay-on-line", + grantedAt: "2024-01-15T09:30:00Z" + } + }, + campaignId: "campaignId", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, + numberToDigitsCutoff: 2025 + } }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - voice: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadId: "squadId", + squad: { + name: "name", + members: [{ + assistantDestinations: [{ + type: "assistant", + assistantName: "assistantName" + }], + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, + position: -1 + } + }] + } + } + }] + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -38241,411 +15487,119 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - ], - membersOverrides: { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -38655,68 +15609,55 @@ describe("CallsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -38725,28 +15666,23 @@ describe("CallsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -38755,227 +15691,127 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -38983,66 +15819,31 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -39050,8 +15851,8 @@ describe("CallsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -39064,888 +15865,865 @@ describe("CallsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - squadOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - ], - "tools:append": [ - { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], - }, - }, - keypadInputPlan: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - }, - workflowId: "workflowId", - workflow: { - nodes: [ - { - type: "conversation", - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - voice: { + fallbackPlan: { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - tools: [ - { + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - name: "name", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - ], - model: { - provider: "openai", - model: "gpt-5.4", - temperature: 1.1, - maxTokens: 1.1, - }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + workflowId: "workflowId", + workflow: { + nodes: [{ + type: "conversation", transcriber: { provider: "assembly-ai", - language: "multi", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, voice: { provider: "azure", @@ -39954,562 +16732,656 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, - speed: 1.1, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - voicemailDetection: "off", - maxDurationSeconds: 600, - name: "name", - edges: [ - { - from: "from", - to: "to", - }, - ], - globalPrompt: "globalPrompt", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + name: "name" + }], + model: { + provider: "openai", + messages: [{ + content: null, + role: "assistant" + }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1 + }, + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + voicemailDetection: "off", + maxDurationSeconds: 600, + name: "name", + edges: [{ + from: "from", + to: "to" + }], + globalPrompt: "globalPrompt", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], - }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - credentialIds: ["credentialIds"], - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - voicemailMessage: "voicemailMessage", + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true }, - workflowOverrides: { - variableValues: { - key: "value", - }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", - }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + credentialIds: ["credentialIds"], + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + }, + voicemailMessage: "voicemailMessage" + }, + workflowOverrides: { + variableValues: { + "key": "value" + } + }, + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer" + }, + description: "description" + }, + hooks: [{ + on: "call.ringing", + "do": [{ + type: "transfer" + }] + }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + customerId: "customerId", + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - customerId: "customerId", - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -40517,445 +17389,913 @@ describe("CallsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"] + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" }, name: "name", - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - transport: { - key: "value", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, - subscriptionLimits: { - concurrencyBlocked: true, - concurrencyLimit: 1.1, - remainingConcurrentCalls: 1.1, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, - }); + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }, + name: "name", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("CallArtifactController_monoRecordingDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/mono-recording").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerMonoRecordingDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_monoRecordingDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/mono-recording").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerMonoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_monoRecordingDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/mono-recording").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerMonoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_stereoRecordingDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/stereo-recording").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerStereoRecordingDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_stereoRecordingDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/stereo-recording").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerStereoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_stereoRecordingDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/stereo-recording").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerStereoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_videoRecordingDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/video-recording").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerVideoRecordingDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_videoRecordingDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/video-recording").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerVideoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_videoRecordingDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/video-recording").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerVideoRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_customerRecordingDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/customer-recording").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerCustomerRecordingDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_customerRecordingDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/customer-recording").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerCustomerRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_customerRecordingDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/customer-recording").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerCustomerRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_assistantRecordingDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/assistant-recording").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerAssistantRecordingDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_assistantRecordingDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/assistant-recording").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerAssistantRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_assistantRecordingDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/assistant-recording").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerAssistantRecordingDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_pcapDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/pcap").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerPcapDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_pcapDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/pcap").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerPcapDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_pcapDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/pcap").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerPcapDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); + }); + + test("CallArtifactController_callLogsDownload (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + + + server + .mockEndpoint() + .get("/call/id/call-logs").respondWith() + .statusCode(200).build(); + + + + const response = await client.calls.callArtifactControllerCallLogsDownload({ + id: "id" +}); + expect(response).toEqual(undefined); + + + }); + + test("CallArtifactController_callLogsDownload (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/call-logs").respondWith() + .statusCode(401).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerCallLogsDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.UnauthorizedError); + }); + + test("CallArtifactController_callLogsDownload (3)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "key" : "value" }; + + server + .mockEndpoint() + .get("/call/id/call-logs").respondWith() + .statusCode(404).jsonBody(rawResponseBody) + .build(); + + + await expect(async () => { + return await client.calls.callArtifactControllerCallLogsDownload({ + id: "id" +}) + }).rejects.toThrow(Vapi.NotFoundError); }); + }); diff --git a/tests/wire/campaigns.test.ts b/tests/wire/campaigns.test.ts index 0d05cb0f..da17e602 100644 --- a/tests/wire/campaigns.test.ts +++ b/tests/wire/campaigns.test.ts @@ -4,446 +4,34 @@ import { VapiClient } from "../../src/Client"; import { mockServerPool } from "../mock-server/MockServerPool"; describe("CampaignsClient", () => { + test("CampaignController_findAll", async () => { const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "results" : [ { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 } ] , "metadata" : { "itemsPerPage" : 1.1 , "totalItems" : 1.1 , "currentPage" : 1.1 , "totalPages" : 1.1 , "hasNextPage" : true , "nextCursor" : "nextCursor" , "sortOrder" : "ASC" , "itemsBeyondRetention" : true , "createdAtLe" : "2024-01-15T09:30:00Z" , "createdAtGe" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .get("/campaign").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); - const rawResponseBody = { - results: [ - { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + + + const response = await client.campaigns.campaignControllerFindAll(); + expect(response).toEqual({ + results: [{ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: - "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - }, - ], - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z" }, - customers: [ - { + customers: [{ assistantOverrides: { transcriber: { provider: "assembly-ai", @@ -454,51 +42,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -506,19 +98,24 @@ describe("CampaignsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -527,162 +124,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -690,57 +252,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -748,8 +284,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -761,980 +297,286 @@ describe("CampaignsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { key: "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }, - ], - metadata: { - itemsPerPage: 1.1, - totalItems: 1.1, - currentPage: 1.1, - itemsBeyondRetention: true, - createdAtLe: "2024-01-15T09:30:00Z", - createdAtGe: "2024-01-15T09:30:00Z", - }, - }; - - server.mockEndpoint().get("/campaign").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.campaigns.campaignControllerFindAll(); - expect(response).toEqual({ - results: [ - { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, - model: { - provider: "anthropic", - tools: [ - { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: - "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - }, - ], - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - }, - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -1742,63 +584,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -1806,8 +616,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -1820,88 +630,49 @@ describe("CampaignsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, @@ -1909,545 +680,87 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { - key: "value", - }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }, - ], - metadata: { - itemsPerPage: 1.1, - totalItems: 1.1, - currentPage: 1.1, - itemsBeyondRetention: true, - createdAtLe: "2024-01-15T09:30:00Z", - createdAtGe: "2024-01-15T09:30:00Z", - }, - }); - }); - - test("CampaignController_create", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = { name: "Q2 Sales Campaign" }; - const rawResponseBody = { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - }, - ], - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -2455,19 +768,24 @@ describe("CampaignsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -2476,162 +794,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -2639,57 +922,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -2697,8 +954,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -2710,246 +967,286 @@ describe("CampaignsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { key: "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }; - - server - .mockEndpoint() - .post("/campaign") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.campaigns.campaignControllerCreate({ - name: "Q2 Sales Campaign", - }); - expect(response).toEqual({ - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, - model: { - provider: "anthropic", - tools: [ - { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -2957,523 +1254,665 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - server: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - }, - ], - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - model: { - provider: "anthropic", - tools: [ - { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -3481,213 +1920,412 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 + }], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("CampaignController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { "name" : "Q2 Sales Campaign" }; + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .post("/campaign").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerCreate({ + name: "Q2 Sales Campaign" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -3695,63 +2333,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -3759,8 +2365,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -3773,88 +2379,49 @@ describe("CampaignsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, @@ -3862,540 +2429,81 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { - key: "value", - }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }); - }); - - test("CampaignController_findOne", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - - const rawResponseBody = { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - }, - ], - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -4403,19 +2511,24 @@ describe("CampaignsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -4424,162 +2537,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -4587,57 +2665,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -4645,8 +2697,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -4658,239 +2710,8053 @@ describe("CampaignsClient", () => { pcapUseCustomStorageEnabled: true, loggingEnabled: true, loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - schema: { type: "string" }, - }, - ], + schema: { + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, + smartEndpointingPlan: { + provider: "vapi" + }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", + model: "claude-3-opus-20240229" }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { key: "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }; - - server.mockEndpoint().get("/campaign/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.campaigns.campaignControllerFindOne({ - id: "id", - }); - expect(response).toEqual({ - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_findAllV2", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "results" : [ { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" } , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "contactCounters" : { "pending" : 1.1 , "dispatched" : 1.1 , "completed" : 1.1 , "failed" : 1.1 , "skipped" : 1.1 , "predialFailed" : 1.1 } , "callMetrics" : { "dialed" : 1.1 , "connected" : 1.1 } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" } ] , "metadata" : { "itemsPerPage" : 1.1 , "totalItems" : 1.1 , "currentPage" : 1.1 , "totalPages" : 1.1 , "hasNextPage" : true , "nextCursor" : "nextCursor" , "sortOrder" : "ASC" , "itemsBeyondRetention" : true , "createdAtLe" : "2024-01-15T09:30:00Z" , "createdAtGe" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .get("/v2/campaign").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerFindAllV2(); + expect(response).toEqual({ + results: [{ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z" + }, + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + contactCounters: { + pending: 1.1, + dispatched: 1.1, + completed: 1.1, + failed: 1.1, + skipped: 1.1, + predialFailed: 1.1 + }, + callMetrics: { + dialed: 1.1, + connected: 1.1 + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z" + }], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z" + } +}); + + + }); + + test("CampaignController_createV2", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { "name" : "Q2 Sales Campaign" }; + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .post("/v2/campaign").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerCreateV2({ + name: "Q2 Sales Campaign" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_findOneV2", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "contactCounters" : { "pending" : 1.1 , "dispatched" : 1.1 , "completed" : 1.1 , "failed" : 1.1 , "skipped" : 1.1 , "predialFailed" : 1.1 } , "callMetrics" : { "dialed" : 1.1 , "connected" : 1.1 } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" }; + + server + .mockEndpoint() + .get("/v2/campaign/id").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerFindOneV2({ + id: "id" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + contactCounters: { + pending: 1.1, + dispatched: 1.1, + completed: 1.1, + failed: 1.1, + skipped: 1.1, + predialFailed: 1.1 + }, + callMetrics: { + dialed: 1.1, + connected: 1.1 + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z" +}); + + + }); + + test("CampaignController_removeV2", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .delete("/v2/campaign/id").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerRemoveV2({ + id: "id" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: { - provider: "anthropic", - tools: [ - { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_updateV2", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .patch("/v2/campaign/id").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerUpdateV2({ + id: "id", + body: {} +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -4898,420 +10764,2041 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - server: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .get("/campaign/id").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerFindOne({ + id: "id" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ assistantOverrides: { transcriber: { provider: "assembly-ai", @@ -5322,68 +12809,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -5392,28 +12866,23 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -5422,213 +12891,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -5636,63 +13019,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -5700,8 +13051,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -5714,88 +13065,49 @@ describe("CampaignsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, @@ -5803,142 +13115,235 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, + model: "claude-3-opus-20240229" }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { - key: "value", - }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }); - }); - - test("CampaignController_remove", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - - const rawResponseBody = { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -5946,342 +13351,1709 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - server: { + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" }, - ], - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .delete("/campaign/id").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerRemove({ + id: "id" +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ assistantOverrides: { transcriber: { provider: "assembly-ai", @@ -6292,51 +15064,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -6344,916 +15120,273 @@ describe("CampaignsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { key: "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }; - - server.mockEndpoint().delete("/campaign/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.campaigns.campaignControllerRemove({ - id: "id", - }); - expect(response).toEqual({ - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - ], - }, - ], - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -7263,68 +15396,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -7333,28 +15453,23 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -7363,213 +15478,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -7577,63 +15606,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -7641,8 +15638,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -7655,574 +15652,1665 @@ describe("CampaignsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", + model: "claude-3-opus-20240229" }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { - key: "value", - }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }); - }); - - test("CampaignController_update", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" }, - ], - schedulePlan: { earliestAt: "2024-01-15T09:30:00Z", latestAt: "2024-01-15T09:30:00Z" }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + const rawRequestBody = { }; + const rawResponseBody = { "status" : "scheduled" , "endedReason" : "campaign.scheduled.ended-by-user" , "name" : "Q2 Sales Campaign" , "assistantId" : "assistantId" , "workflowId" : "workflowId" , "squadId" : "squadId" , "phoneNumberId" : "phoneNumberId" , "dialPlan" : [ { "phoneNumberId" : "phoneNumberId" , "customers" : [ { "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } } ] } ] , "schedulePlan" : { "earliestAt" : "2024-01-15T09:30:00Z" , "latestAt" : "2024-01-15T09:30:00Z" } , "customers" : [ { "numberE164CheckEnabled" : true , "extension" : "extension" , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "compliancePlan" : { "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "number" : "number" , "sipUri" : "sipUri" , "name" : "name" , "email" : "email" , "externalId" : "externalId" } ] , "maxConcurrency" : 1.1 , "assistantOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "squadOverrides" : { "transcriber" : { "provider" : "assembly-ai" , "language" : "multi" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true , "mode" : "max_accuracy" , "prompt" : "prompt" , "agentContext" : "agentContext" , "languageCodes" : [ "en" ] , "speechModel" : "universal-streaming-english" , "realtimeUrl" : "realtimeUrl" , "wordBoost" : [ "wordBoost" ] , "keytermsPrompt" : [ "keytermsPrompt" ] , "endUtteranceSilenceThreshold" : 1.1 , "disablePartialTranscripts" : true , "fallbackPlan" : { "transcribers" : [ { "provider" : "assembly-ai" , "confidenceThreshold" : 0.4 , "formatTurns" : true , "endOfTurnConfidenceThreshold" : 0.7 , "minEndOfTurnSilenceWhenConfident" : 160 , "maxTurnSilence" : 400 , "vadAssistedEndpointingEnabled" : true } ] } } , "model" : { "provider" : "anthropic" , "messages" : [ { "content" : null , "role" : "assistant" } ] , "tools" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "toolIds" : [ "toolIds" ] , "toolRefs" : [ { "toolId" : "toolId" , "version" : "version" } ] , "knowledgeBase" : { "provider" : "custom-knowledge-base" , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } } , "model" : "claude-3-opus-20240229" , "thinking" : { "type" : "enabled" , "budgetTokens" : 1.1 } , "temperature" : 1.1 , "maxTokens" : 1.1 , "emotionRecognitionEnabled" : true , "numFastTurns" : 1.1 } , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "speed" : 1.1 , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "firstMessage" : "Hello! How can I help you today?" , "firstMessageInterruptionsEnabled" : true , "firstMessageMode" : "assistant-speaks-first" , "voicemailDetection" : "off" , "clientMessages" : [ "conversation-update" , "function-call" , "hang" , "model-output" , "speech-update" , "status-update" , "transfer-update" , "transcript" , "tool-calls" , "user-interrupted" , "voice-input" , "workflow.node.started" , "assistant.started" ] , "serverMessages" : [ "conversation-update" , "end-of-call-report" , "function-call" , "hang" , "speech-update" , "status-update" , "tool-calls" , "transfer-destination-request" , "handoff-destination-request" , "user-interrupted" , "assistant.started" ] , "maxDurationSeconds" : 600 , "backgroundSound" : "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3" , "modelOutputInMessagesEnabled" : false , "transportConfigurations" : [ { "provider" : "twilio" , "timeout" : 60 , "record" : false } ] , "observabilityPlan" : { "provider" : "langfuse" , "promptName" : "promptName" , "promptVersion" : 1.1 , "traceName" : "traceName" , "tags" : [ "tags" ] , "metadata" : { "key" : "value" } } , "credentials" : [ { "provider" : "11labs" , "apiKey" : "apiKey" } ] , "hooks" : [ { "on" : "call.ending" , "do" : [ { "type" : "tool" , "tool" : { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } } ] } ] , "tools:append" : [ { "type" : "apiRequest" , "messages" : [ { "type" : "request-start" , "blocking" : false } ] , "method" : "POST" , "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "url" : "url" , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } , "rejectionPlan" : { "conditions" : [ { "type" : "regex" , "regex" : "\\\\b(cancel|stop|wait)\\\\b - Matches whole words" , "target" : { "position" : -1 } } ] } } ] , "variableValues" : { "key" : "value" } , "name" : "name" , "voicemailMessage" : "voicemailMessage" , "endCallMessage" : "endCallMessage" , "endCallPhrases" : [ "endCallPhrases" ] , "compliancePlan" : { "hipaaEnabled" : true , "pciEnabled" : true , "recordingConsentPlan" : { "type" : "stay-on-line" , "message" : "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent." , "voice" : { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } , "fallbackPlan" : { "voices" : [ { "provider" : "azure" , "cachingEnabled" : true , "voiceId" : "andrew" , "chunkPlan" : { "enabled" : true , "minCharacters" : 30 , "punctuationBoundaries" : [ "。" , "，" , "." , "!" , "?" , ";" , "،" , "۔" , "।" , "॥" , "|" , "||" , "," , ":" ] , "formatPlan" : { "enabled" : true , "numberToDigitsCutoff" : 2025 } } } ] } } , "waitSeconds" : 3 } } , "metadata" : { "key" : "value" } , "backgroundSpeechDenoisingPlan" : { "fourierDenoisingPlan" : { "mediaDetectionEnabled" : true , "staticThreshold" : -35 , "baselineOffsetDb" : -15 , "windowSizeMs" : 3000 , "baselinePercentile" : 85 } } , "artifactPlan" : { "recordingEnabled" : true , "recordingFormat" : "wav;l16" , "recordingUseCustomStorageEnabled" : true , "videoRecordingEnabled" : false , "fullMessageHistoryEnabled" : false , "pcapEnabled" : true , "pcapS3PathPrefix" : "/pcaps" , "pcapUseCustomStorageEnabled" : true , "loggingEnabled" : true , "loggingUseCustomStorageEnabled" : true , "transcriptPlan" : { "enabled" : true } , "recordingPath" : "recordingPath" , "structuredOutputIds" : [ "structuredOutputIds" ] , "structuredOutputs" : [ { "compliancePlan" : { "forceStoreOnHipaaEnabled" : false } , "conditions" : [ { "type" : "minMessages" , "count" : 4 } , { "type" : "minCallDuration" , "seconds" : 10 } ] , "name" : "name" , "schema" : { "type" : "string" } } ] , "scorecardIds" : [ "scorecardIds" ] , "scorecards" : [ { "metrics" : [ { "conditions" : [ { "type" : "comparator" , "comparator" : "=" , "value" : 1.1 , "points" : 1.1 } ] , "structuredOutputId" : "structuredOutputId" } ] } ] , "loggingPath" : "loggingPath" } , "startSpeakingPlan" : { "waitSeconds" : 0.4 , "smartEndpointingPlan" : { "provider" : "vapi" } , "customEndpointingRules" : [ { "type" : "assistant" , "regex" : "regex" , "timeoutSeconds" : 1.1 } ] , "transcriptionEndpointingPlan" : { "onPunctuationSeconds" : 0.1 , "onNoPunctuationSeconds" : 1.5 , "onNumberSeconds" : 0.5 } } , "stopSpeakingPlan" : { "numWords" : 0 , "voiceSeconds" : 0.2 , "backoffSeconds" : 1 , "acknowledgementPhrases" : [ "i understand" , "i see" , "i got it" , "i hear you" , "im listening" , "im with you" , "right" , "okay" , "ok" , "sure" , "alright" , "got it" , "understood" , "yeah" , "yes" , "uh-huh" , "mm-hmm" , "gotcha" , "mhmm" , "ah" , "yeah okay" , "yeah sure" ] , "interruptionPhrases" : [ "stop" , "shut" , "up" , "enough" , "quiet" , "silence" , "but" , "dont" , "not" , "no" , "hold" , "wait" , "cut" , "pause" , "nope" , "nah" , "nevermind" , "never" , "bad" , "actually" ] } , "monitorPlan" : { "listenEnabled" : false , "listenAuthenticationEnabled" : false , "controlEnabled" : false , "controlAuthenticationEnabled" : false , "monitorIds" : [ "123e4567-e89b-12d3-a456-426614174000" ] } , "credentialIds" : [ "credentialIds" ] , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "keypadInputPlan" : { "enabled" : true , "timeoutSeconds" : 1.1 , "delimiters" : "#" } } , "server" : { "timeoutSeconds" : 20 , "credentialId" : "550e8400-e29b-41d4-a716-446655440000" , "staticIpAddressesEnabled" : false , "encryptedPaths" : [ "encryptedPaths" ] , "url" : "url" , "headers" : { "key" : "value" } , "backoffPlan" : { "type" : { "key" : "value" } , "maxRetries" : 0 , "baseDelaySeconds" : 1 , "excludedStatusCodes" : [ { "key" : "value" } , { "key" : "value" } , { "key" : "value" } , { "key" : "value" } ] } } , "serverMessages" : [ "campaign.started" , "contact.dispatched" ] , "predialPlan" : { "enabled" : true } , "id" : "id" , "orgId" : "orgId" , "createdAt" : "2024-01-15T09:30:00Z" , "updatedAt" : "2024-01-15T09:30:00Z" , "calls" : { "key" : "value" } , "callsCounterScheduled" : 1.1 , "callsCounterQueued" : 1.1 , "callsCounterInProgress" : 1.1 , "callsCounterEndedVoicemail" : 1.1 , "callsCounterEnded" : 1.1 }; + + server + .mockEndpoint() + .patch("/campaign/id").jsonBody(rawRequestBody) + .respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerUpdate({ + id: "id", + body: {} +}); + expect(response).toEqual({ + status: "scheduled", + endedReason: "campaign.scheduled.ended-by-user", + name: "Q2 Sales Campaign", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + phoneNumberId: "phoneNumberId", + dialPlan: [{ + phoneNumberId: "phoneNumberId", + customers: [{ assistantOverrides: { transcriber: { provider: "assembly-ai", @@ -8233,51 +17321,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [{ + type: "request-start", + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], + target: { + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -8285,19 +17377,24 @@ describe("CampaignsClient", () => { credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + "key": "value" + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -8306,480 +17403,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { key: "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }; - - server - .mockEndpoint() - .patch("/campaign/id") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.campaigns.campaignControllerUpdate({ - id: "id", - }); - expect(response).toEqual({ - status: "scheduled", - endedReason: "campaign.scheduled.ended-by-user", - name: "Q2 Sales Campaign", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - phoneNumberId: "phoneNumberId", - dialPlan: [ - { - phoneNumberId: "phoneNumberId", - customers: [ - { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -8787,421 +17531,119 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, - }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } }, - ], - }, - ], - schedulePlan: { - earliestAt: "2024-01-15T09:30:00Z", - latestAt: "2024-01-15T09:30:00Z", - }, - customers: [ - { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -9211,68 +17653,55 @@ describe("CampaignsClient", () => { maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, fallbackPlan: { - transcribers: [ - { + transcribers: [{ provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + vadAssistedEndpointingEnabled: true + }] + } }, model: { provider: "anthropic", - tools: [ - { + tools: [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -9281,28 +17710,23 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } }, - model: "claude-3-opus-20240229", + model: "claude-3-opus-20240229" }, voice: { provider: "azure", @@ -9311,213 +17735,127 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], maxDurationSeconds: 600, backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { + transportConfigurations: [{ provider: "twilio", timeout: 60, - record: false, - }, - ], - credentials: [ - { + record: false + }], + credentials: [{ provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { + apiKey: "apiKey" + }], + hooks: [{ on: "call.ending", - do: [ - { + "do": [{ + type: "tool", type: "tool", tool: { type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ type: "apiRequest", - messages: [ - { + messages: [{ type: "request-start", - blocking: false, - }, - ], + blocking: false + }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, rejectionPlan: { - conditions: [ - { + conditions: [{ type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", target: { - position: -1, - }, - }, - ], - }, - }, - ], + position: -1 + } + }] + } + }], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -9525,63 +17863,31 @@ describe("CampaignsClient", () => { chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, + numberToDigitsCutoff: 2025 + } }, fallbackPlan: { - voices: [ - { + voices: [{ provider: "azure", cachingEnabled: true, voiceId: "andrew", chunkPlan: { enabled: true, minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], formatPlan: { enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + numberToDigitsCutoff: 2025 + } + } + }] + } }, - waitSeconds: 3, - }, + waitSeconds: 3 + } }, backgroundSpeechDenoisingPlan: { fourierDenoisingPlan: { @@ -9589,8 +17895,8 @@ describe("CampaignsClient", () => { staticThreshold: -35, baselineOffsetDb: -15, windowSizeMs: 3000, - baselinePercentile: 85, - }, + baselinePercentile: 85 + } }, artifactPlan: { recordingEnabled: true, @@ -9603,88 +17909,49 @@ describe("CampaignsClient", () => { loggingEnabled: true, loggingUseCustomStorageEnabled: true, transcriptPlan: { - enabled: true, + enabled: true }, - structuredOutputs: [ - { + structuredOutputs: [{ compliancePlan: { - forceStoreOnHipaaEnabled: false, + forceStoreOnHipaaEnabled: false }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", schema: { - type: "string", - }, - }, - ], + type: "string" + } + }] }, startSpeakingPlan: { waitSeconds: 0.4, smartEndpointingPlan: { - provider: "vapi", + provider: "vapi" }, transcriptionEndpointingPlan: { onPunctuationSeconds: 0.1, onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, + onNumberSeconds: 0.5 + } }, stopSpeakingPlan: { numWords: 0, voiceSeconds: 0.2, backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] }, monitorPlan: { listenEnabled: false, listenAuthenticationEnabled: false, controlEnabled: false, controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] }, server: { timeoutSeconds: 20, @@ -9692,46 +17959,1627 @@ describe("CampaignsClient", () => { staticIpAddressesEnabled: false, backoffPlan: { type: { - key: "value", + "key": "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + } + }] + }], + schedulePlan: { + earliestAt: "2024-01-15T09:30:00Z", + latestAt: "2024-01-15T09:30:00Z" + }, + customers: [{ + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - { - key: "value", + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229" + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, - ], + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }] + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId" + }], + maxConcurrency: 1.1, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false + }, + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], + name: "name", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [{ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true + }] + } + }, + model: { + provider: "anthropic", + messages: [{ + content: null, + role: "assistant" + }], + tools: [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + toolIds: ["toolIds"], + toolRefs: [{ + toolId: "toolId", + version: "version" + }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + "key": "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + } + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1 + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1 + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + speed: 1.1, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: ["conversation-update", "function-call", "hang", "model-output", "speech-update", "status-update", "transfer-update", "transcript", "tool-calls", "user-interrupted", "voice-input", "workflow.node.started", "assistant.started"], + serverMessages: ["conversation-update", "end-of-call-report", "function-call", "hang", "speech-update", "status-update", "tool-calls", "transfer-destination-request", "handoff-destination-request", "user-interrupted", "assistant.started"], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ + provider: "twilio", + timeout: 60, + record: false + }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + "key": "value" + } + }, + credentials: [{ + provider: "11labs", + apiKey: "apiKey" + }], + hooks: [{ + on: "call.ending", + "do": [{ + type: "tool", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + } + }] + }], + "tools:append": [{ + type: "apiRequest", + messages: [{ + type: "request-start", + blocking: false + }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + "key": "value" + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + }, + rejectionPlan: { + conditions: [{ + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1 + } + }] + } + }], + variableValues: { + "key": "value" + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + }, + fallbackPlan: { + voices: [{ + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: ["\u3002", "\uFF0C", ".", "!", "?", ";", "\u060C", "\u06D4", "\u0964", "\u0965", "|", "||", ",", ":"], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025 + } + } + }] + } + }, + waitSeconds: 3 + } + }, + metadata: { + "key": "value" + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85 + } + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [{ + compliancePlan: { + forceStoreOnHipaaEnabled: false }, - number: "number", - sipUri: "sipUri", + conditions: [{ + type: "minMessages", + count: 4 + }, { + type: "minCallDuration", + seconds: 10 + }], name: "name", - email: "email", - externalId: "externalId", + schema: { + type: "string" + } + }], + scorecardIds: ["scorecardIds"], + scorecards: [{ + metrics: [{ + conditions: [{ + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1 + }], + structuredOutputId: "structuredOutputId" + }] + }], + loggingPath: "loggingPath" + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi" + }, + customEndpointingRules: [{ + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1 + }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5 + } + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: ["i understand", "i see", "i got it", "i hear you", "im listening", "im with you", "right", "okay", "ok", "sure", "alright", "got it", "understood", "yeah", "yes", "uh-huh", "mm-hmm", "gotcha", "mhmm", "ah", "yeah okay", "yeah sure"], + interruptionPhrases: ["stop", "shut", "up", "enough", "quiet", "silence", "but", "dont", "not", "no", "hold", "wait", "cut", "pause", "nope", "nah", "nevermind", "never", "bad", "actually"] + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"] + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" }, - ], - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - calls: { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#" + } + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + "key": "value" + }, + backoffPlan: { + type: { + "key": "value" }, - callsCounterScheduled: 1.1, - callsCounterQueued: 1.1, - callsCounterInProgress: 1.1, - callsCounterEndedVoicemail: 1.1, - callsCounterEnded: 1.1, - }); + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }, { + "key": "value" + }] + } + }, + serverMessages: ["campaign.started", "contact.dispatched"], + predialPlan: { + enabled: true + }, + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + calls: { + "key": "value" + }, + callsCounterScheduled: 1.1, + callsCounterQueued: 1.1, + callsCounterInProgress: 1.1, + callsCounterEndedVoicemail: 1.1, + callsCounterEnded: 1.1 +}); + + + }); + + test("CampaignController_getCampaignV2Contacts", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ "maxRetries" : 0 , "token" : "test" , "environment" : server.baseUrl }); + + const rawResponseBody = { "results" : [ { "id" : "id" , "number" : "number" , "name" : "name" , "status" : "contact.pending" , "callId" : "callId" , "dispatchedAt" : "2024-01-15T09:30:00Z" , "endedReason" : "endedReason" } ] , "metadata" : { "itemsPerPage" : 1.1 , "totalItems" : 1.1 , "currentPage" : 1.1 , "totalPages" : 1.1 , "hasNextPage" : true , "nextCursor" : "nextCursor" , "sortOrder" : "ASC" , "itemsBeyondRetention" : true , "createdAtLe" : "2024-01-15T09:30:00Z" , "createdAtGe" : "2024-01-15T09:30:00Z" } }; + + server + .mockEndpoint() + .get("/v2/campaign/id/contacts").respondWith() + .statusCode(200).jsonBody(rawResponseBody) + .build(); + + + + const response = await client.campaigns.campaignControllerGetCampaignV2Contacts({ + id: "id" +}); + expect(response).toEqual({ + results: [{ + id: "id", + number: "number", + name: "name", + status: "contact.pending", + callId: "callId", + dispatchedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason" + }], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z" + } +}); + + }); + }); diff --git a/tests/wire/chats.test.ts b/tests/wire/chats.test.ts index c6234efb..a4304c78 100644 --- a/tests/wire/chats.test.ts +++ b/tests/wire/chats.test.ts @@ -303,6 +303,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -713,6 +717,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1101,6 +1109,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1514,6 +1526,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1926,6 +1942,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -2037,6 +2057,10 @@ describe("ChatsClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -2414,6 +2438,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2926,6 +2960,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -3401,6 +3445,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -3913,6 +3967,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4427,6 +4491,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4574,6 +4648,10 @@ describe("ChatsClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -4597,6 +4675,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -4651,6 +4733,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -4914,13 +4997,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -5019,6 +5113,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -5073,6 +5171,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -5367,13 +5466,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -5759,6 +5869,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -6169,6 +6283,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -6591,6 +6709,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -6700,6 +6822,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], @@ -6730,6 +6853,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -6806,6 +6933,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -7130,6 +7263,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -7141,12 +7284,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -7277,6 +7423,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -7353,6 +7503,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -7727,6 +7883,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -7738,12 +7904,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -8237,6 +8406,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -8749,6 +8928,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -9280,6 +9469,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -9419,6 +9618,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], @@ -9442,6 +9642,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -9496,6 +9700,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -9759,13 +9964,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -9864,6 +10080,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -9918,6 +10138,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -10212,13 +10433,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -10604,6 +10836,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -11014,6 +11250,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -11436,6 +11676,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -11545,6 +11789,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], @@ -11568,6 +11813,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -11644,6 +11893,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -11968,6 +12223,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -11979,12 +12244,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -12115,6 +12383,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -12191,6 +12463,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -12565,6 +12843,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -12576,12 +12864,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -13075,6 +13366,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -13587,6 +13888,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -14118,6 +14429,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -14257,6 +14578,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], @@ -14280,6 +14602,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -14334,6 +14660,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -14597,13 +14924,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -14702,6 +15040,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -14756,6 +15098,7 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -15050,13 +15393,24 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -15442,6 +15796,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -15852,6 +16210,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -16274,6 +16636,10 @@ describe("ChatsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -16383,6 +16749,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], @@ -16406,6 +16773,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -16482,6 +16853,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -16806,6 +17183,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -16817,12 +17204,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -16953,6 +17343,10 @@ describe("ChatsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -17029,6 +17423,12 @@ describe("ChatsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -17403,6 +17803,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -17414,12 +17824,15 @@ describe("ChatsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -17913,6 +18326,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -18425,6 +18848,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -18956,6 +19389,16 @@ describe("ChatsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -19095,6 +19538,7 @@ describe("ChatsClient", () => { promptTokens: 1.1, completionTokens: 1.1, cachedPromptTokens: 1.1, + reasoningTokens: 1.1, cost: 1.1, }, ], diff --git a/tests/wire/eval.test.ts b/tests/wire/eval.test.ts index 51c8bad1..aecc11b0 100644 --- a/tests/wire/eval.test.ts +++ b/tests/wire/eval.test.ts @@ -31,6 +31,10 @@ describe("EvalClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -70,6 +74,10 @@ describe("EvalClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -621,6 +629,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1042,6 +1054,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1559,6 +1575,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2089,6 +2115,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2546,6 +2582,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -2967,6 +3007,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -3484,6 +3528,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4014,6 +4068,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4464,6 +4528,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -4874,6 +4942,10 @@ describe("EvalClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -4989,6 +5061,10 @@ describe("EvalClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -5386,6 +5462,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -5898,6 +5984,16 @@ describe("EvalClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -6036,6 +6132,10 @@ describe("EvalClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", diff --git a/tests/wire/files.test.ts b/tests/wire/files.test.ts index b64d2a7e..782d0545 100644 --- a/tests/wire/files.test.ts +++ b/tests/wire/files.test.ts @@ -33,7 +33,9 @@ describe("FilesClient", () => { server.mockEndpoint().get("/file").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - const response = await client.files.list(); + const response = await client.files.list({ + purpose: "purpose", + }); expect(response).toEqual([ { object: "file", diff --git a/tests/wire/insight.test.ts b/tests/wire/insight.test.ts index ef80996d..8f864b72 100644 --- a/tests/wire/insight.test.ts +++ b/tests/wire/insight.test.ts @@ -17,12 +17,17 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }, ], metadata: { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -41,12 +46,17 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }, ], metadata: { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -88,6 +98,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }; server @@ -157,6 +168,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }); }); @@ -191,6 +203,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }; server @@ -251,6 +264,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }); }); @@ -285,6 +299,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }; server @@ -345,6 +360,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }); }); @@ -379,6 +395,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }; server @@ -443,6 +460,7 @@ describe("InsightClient", () => { orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", updatedAt: "2024-01-15T09:30:00Z", + systemKey: "systemKey", }); }); diff --git a/tests/wire/knowledgeBasesV2.test.ts b/tests/wire/knowledgeBasesV2.test.ts new file mode 100644 index 00000000..fcef95e1 --- /dev/null +++ b/tests/wire/knowledgeBasesV2.test.ts @@ -0,0 +1,370 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("KnowledgeBasesV2Client", () => { + test("KnowledgeBaseV2Controller_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ]; + + server.mockEndpoint().get("/v2/knowledge-base").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindAll(); + expect(response).toEqual([ + { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ]); + }); + + test("KnowledgeBaseV2Controller_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { name: "name" }; + const rawResponseBody = { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .post("/v2/knowledge-base") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerCreate({ + name: "name", + }); + expect(response).toEqual({ + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); + + test("KnowledgeBaseV2Controller_filesGet", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ]; + + server + .mockEndpoint() + .get("/v2/knowledge-base/id/file") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFilesGet({ + id: "id", + }); + expect(response).toEqual([ + { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ]); + }); + + test("KnowledgeBaseV2Controller_fileAttach", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { fileId: "fileId" }; + const rawResponseBody = { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .post("/v2/knowledge-base/id/file") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileAttach({ + id: "id", + fileId: "fileId", + }); + expect(response).toEqual({ + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); + + test("KnowledgeBaseV2Controller_fileDetach", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .delete("/v2/knowledge-base/id/file/fileId") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileDetach({ + id: "id", + fileId: "fileId", + }); + expect(response).toEqual({ + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); + + test("KnowledgeBaseV2Controller_fileRetry", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .post("/v2/knowledge-base/id/file/fileId/retry") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFileRetry({ + id: "id", + fileId: "fileId", + }); + expect(response).toEqual({ + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); + + test("KnowledgeBaseV2Controller_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + files: [ + { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ], + toolId: "toolId", + }; + + server + .mockEndpoint() + .get("/v2/knowledge-base/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + files: [ + { + id: "id", + knowledgeBaseV2Id: "knowledgeBaseV2Id", + fileId: "fileId", + fileName: "fileName", + mimetype: "mimetype", + bytes: 1.1, + status: "indexing", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }, + ], + toolId: "toolId", + }); + }); + + test("KnowledgeBaseV2Controller_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .delete("/v2/knowledge-base/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); + + test("KnowledgeBaseV2Controller_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }; + + server + .mockEndpoint() + .patch("/v2/knowledge-base/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.knowledgeBasesV2.knowledgeBaseV2ControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + name: "name", + description: "description", + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + }); + }); +}); diff --git a/tests/wire/observabilityScorecard.test.ts b/tests/wire/observabilityScorecard.test.ts index a6951bc6..6b7e0a7c 100644 --- a/tests/wire/observabilityScorecard.test.ts +++ b/tests/wire/observabilityScorecard.test.ts @@ -15,7 +15,12 @@ describe("ObservabilityScorecardClient", () => { updatedAt: "2024-01-15T09:30:00Z", name: "name", description: "description", - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], assistantIds: ["assistantIds"], }; @@ -39,12 +44,15 @@ describe("ObservabilityScorecardClient", () => { description: "description", metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], assistantIds: ["assistantIds"], @@ -62,7 +70,12 @@ describe("ObservabilityScorecardClient", () => { updatedAt: "2024-01-15T09:30:00Z", name: "name", description: "description", - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], assistantIds: ["assistantIds"], }; @@ -86,12 +99,15 @@ describe("ObservabilityScorecardClient", () => { description: "description", metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], assistantIds: ["assistantIds"], @@ -109,7 +125,12 @@ describe("ObservabilityScorecardClient", () => { updatedAt: "2024-01-15T09:30:00Z", name: "name", description: "description", - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], assistantIds: ["assistantIds"], }; @@ -134,12 +155,15 @@ describe("ObservabilityScorecardClient", () => { description: "description", metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], assistantIds: ["assistantIds"], @@ -159,7 +183,12 @@ describe("ObservabilityScorecardClient", () => { updatedAt: "2024-01-15T09:30:00Z", name: "name", description: "description", - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], assistantIds: ["assistantIds"], }, ], @@ -167,6 +196,10 @@ describe("ObservabilityScorecardClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -193,12 +226,15 @@ describe("ObservabilityScorecardClient", () => { description: "description", metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], assistantIds: ["assistantIds"], @@ -208,6 +244,10 @@ describe("ObservabilityScorecardClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -219,7 +259,12 @@ describe("ObservabilityScorecardClient", () => { const server = mockServerPool.createServer(); const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); const rawRequestBody = { - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], }; const rawResponseBody = { id: "id", @@ -228,7 +273,12 @@ describe("ObservabilityScorecardClient", () => { updatedAt: "2024-01-15T09:30:00Z", name: "name", description: "description", - metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }], + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], assistantIds: ["assistantIds"], }; @@ -244,12 +294,15 @@ describe("ObservabilityScorecardClient", () => { const response = await client.observabilityScorecard.scorecardControllerCreate({ metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }); @@ -262,12 +315,15 @@ describe("ObservabilityScorecardClient", () => { description: "description", metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], assistantIds: ["assistantIds"], diff --git a/tests/wire/phoneNumbers.test.ts b/tests/wire/phoneNumbers.test.ts index 3dcb07fd..b7444235 100644 --- a/tests/wire/phoneNumbers.test.ts +++ b/tests/wire/phoneNumbers.test.ts @@ -340,6 +340,10 @@ describe("PhoneNumbersClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -411,6 +415,10 @@ describe("PhoneNumbersClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", diff --git a/tests/wire/providerResources.test.ts b/tests/wire/providerResources.test.ts index a4dde073..5b3eaf1b 100644 --- a/tests/wire/providerResources.test.ts +++ b/tests/wire/providerResources.test.ts @@ -26,6 +26,10 @@ describe("ProviderResourcesClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -63,6 +67,10 @@ describe("ProviderResourcesClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", diff --git a/tests/wire/sessions.test.ts b/tests/wire/sessions.test.ts index 21e230ce..86bff04e 100644 --- a/tests/wire/sessions.test.ts +++ b/tests/wire/sessions.test.ts @@ -314,6 +314,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -724,6 +728,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1112,6 +1120,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1525,6 +1537,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1937,6 +1953,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -2350,6 +2370,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -2439,204 +2463,246 @@ describe("SessionsClient", () => { }, }, }, - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - }, - ], - metadata: { - itemsPerPage: 1.1, - totalItems: 1.1, - currentPage: 1.1, - itemsBeyondRetention: true, - createdAtLe: "2024-01-15T09:30:00Z", - createdAtGe: "2024-01-15T09:30:00Z", - }, - }; - - server.mockEndpoint().get("/session").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.sessions.list({ - assistantIdAny: "assistant-1,assistant-2,assistant-3", - customerNumberAny: "+1234567890,+0987654321", - }); - expect(response).toEqual({ - results: [ - { - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { - key: "value", - }, - promptTokens: 1.1, - completionTokens: 1.1, - cost: 1.1, - }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - type: "request-start", - blocking: false, + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - ], + ], + }, }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, }, + model: "claude-3-opus-20240229", }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], }, }, - fallbackPlan: { - voices: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -2644,331 +2710,242 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "\u3002", - "\uFF0C", + "。", + "，", ".", "!", "?", ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", + "،", + "۔", + "।", + "॥", "|", "||", ",", ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], }, }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, ], }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", ], }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, }, }, - assistantOverrides: { + }, + ], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z", + }, + }; + + server.mockEndpoint().get("/session").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.sessions.list({ + assistantIdAny: "assistant-1,assistant-2,assistant-3", + customerNumberAny: "+1234567890,+0987654321", + }); + expect(response).toEqual({ + results: [ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", + model: { + key: "value", + }, + promptTokens: 1.1, + completionTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -3233,53 +3210,6 @@ describe("SessionsClient", () => { ], }, ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", @@ -3377,6 +3307,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -3480,18 +3420,18 @@ describe("SessionsClient", () => { }, }, }, - squadId: "squadId", - squad: { - members: [ - { - assistantDestinations: [ + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -3499,101 +3439,121 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, - model: "claude-3-opus-20240229", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - voice: { + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -3621,146 +3581,193 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, - fallbackPlan: { - voices: [ + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, + type: "request-start", + blocking: false, }, ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ { - provider: "twilio", - timeout: 60, - record: false, + key: "value", }, - ], - credentials: [ { - provider: "11labs", - apiKey: "apiKey", + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], - hooks: [ + }, + rejectionPlan: { + conditions: [ { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -3788,188 +3795,178 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, }, - waitSeconds: 3, - }, + ], }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + conditions: [ + { + type: "minMessages", + count: 4, }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + { + type: "minCallDuration", + seconds: 10, }, + ], + name: "name", + schema: { + type: "string", }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + { + key: "value", }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, + { + key: "value", }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, + { + key: "value", + }, + ], + }, + }, + }, + squadId: "squadId", + squad: { + members: [ + { + assistantDestinations: [ + { + type: "assistant", + assistantName: "assistantName", + }, + ], + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, endOfTurnConfidenceThreshold: 0.7, minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, @@ -4220,53 +4217,6 @@ describe("SessionsClient", () => { ], }, ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], compliancePlan: { recordingConsentPlan: { type: "stay-on-line", @@ -4364,6 +4314,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4467,325 +4427,109 @@ describe("SessionsClient", () => { }, }, }, - }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - key: "value", + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - ], + }, }, + model: "claude-3-opus-20240229", }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -4848,223 +4592,336 @@ describe("SessionsClient", () => { ], }, }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ { - key: "value", + provider: "twilio", + timeout: 60, + record: false, }, + ], + credentials: [ { - key: "value", + provider: "11labs", + apiKey: "apiKey", }, ], - }, - }, - }, - }, - messages: [ - { - role: "role", - message: "message", - time: 1.1, - secondsFromStart: 1.1, - }, - ], - customer: { - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ + hooks: [ { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], }, ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ + "tools:append": [ + { + type: "apiRequest", + messages: [ { - key: "value", + type: "request-start", + blocking: false, }, - { + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value", }, - { - key: "value", + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - { - key: "value", + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], }, - ], + }, + waitSeconds: 3, }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", }, - ], + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -5092,35 +4949,138 @@ describe("SessionsClient", () => { }, }, }, - model: "claude-3-opus-20240229", }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, fallbackPlan: { voices: [ @@ -5400,6 +5360,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -5504,94 +5474,17 @@ describe("SessionsClient", () => { }, }, }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, + messages: [ + { + role: "role", + message: "message", + time: 1.1, + secondsFromStart: 1.1, }, - }, - }, - ], - metadata: { - itemsPerPage: 1.1, - totalItems: 1.1, - currentPage: 1.1, - itemsBeyondRetention: true, - createdAtLe: "2024-01-15T09:30:00Z", - createdAtGe: "2024-01-15T09:30:00Z", - }, - }); - }); - - test("create", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { key: "value" }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, - }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + ], + customer: { + assistantOverrides: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -5599,99 +5492,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -5699,149 +5594,213 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -5849,271 +5808,307 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, }, - rejectionPlan: { - conditions: [ + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, ], }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", ], }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -6121,94 +6116,192 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [ + { + type: "request-start", + blocking: false, + }, + ], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], }, rejectionPlan: { @@ -6216,85 +6309,20 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + target: { + position: -1, + }, }, ], }, }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -6302,160 +6330,301 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", }, }, ], }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], }, }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + ], + metadata: { + itemsPerPage: 1.1, + totalItems: 1.1, + currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", + itemsBeyondRetention: true, + createdAtLe: "2024-01-15T09:30:00Z", + createdAtGe: "2024-01-15T09:30:00Z", }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { + }); + }); + + test("create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", + model: { key: "value" }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -6463,74 +6632,100 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, }, - model: { - provider: "anthropic", - tools: [ + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", }, - voice: { + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -6555,115 +6750,132 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - ], + ], + }, }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -6688,229 +6900,270 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", }, - }, + ], }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, - model: { - provider: "anthropic", - tools: [ + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", }, - voice: { + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -6935,111 +7188,62 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -7067,13 +7271,80 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -7098,331 +7369,179 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, }, + waitSeconds: 3, }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, ], + name: "name", + schema: { type: "string" }, }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", }, - }, + ], }, - model: "claude-3-opus-20240229", + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -7450,50 +7569,28 @@ describe("SessionsClient", () => { ], }, }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, - ], + }, + model: "claude-3-opus-20240229", }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -7550,392 +7647,350 @@ describe("SessionsClient", () => { ], }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", ], - }, - }, - }, - }, - messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, }, ], }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - rejectionPlan: { - conditions: [ + fallbackPlan: { + voices: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, }, ], }, }, + waitSeconds: 3, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], }, - rejectionPlan: { - conditions: [ + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, }, ], }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", "।", "॥", "|", @@ -7976,86 +8031,1533 @@ describe("SessionsClient", () => { ], }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", "hold", "wait", "cut", @@ -8068,138 +9570,718 @@ describe("SessionsClient", () => { "actually", ], }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { mode: "blind-transfer" }, + description: "description", + }, + hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + }, + artifact: { + messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], + messagesOpenAIFormatted: [{ content: null, role: "assistant" }], + skippedStructuredOutputs: { key: { name: "name", unmetCondition: { type: "minMessages", count: 4 } } }, + transfers: [{ destination: { type: "number", number: "number" } }], + recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ assistantName: "assistantName" }], + variableValues: { key: "value" }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { key: "value" }, + scorecards: { key: "value" }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }; + + server + .mockEndpoint() + .post("/session") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.sessions.create(); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", + model: { + key: "value", + }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, + headers: { + key: "value", + }, backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", }, - }; - - server - .mockEndpoint() - .post("/session") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.sessions.create(); - expect(response).toEqual({ - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { - key: "value", - }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, - }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { + assistantOverrides: { transcriber: { provider: "assembly-ai", language: "multi", @@ -8209,6 +10291,10 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -8285,6 +10371,12 @@ describe("SessionsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -8496,10 +10588,60 @@ describe("SessionsClient", () => { ], }, }, - }, - ], + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], + variableValues: { + key: "value", + }, name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -8609,6 +10751,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -8620,12 +10772,15 @@ describe("SessionsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -8746,25 +10901,19 @@ describe("SessionsClient", () => { delimiters: "#", }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [ { + type: "assistant", + assistantName: "assistantName", + }, + ], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -8772,137 +10921,576 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ { - type: "request-start", - blocking: false, + provider: "twilio", + timeout: 60, + record: false, }, ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ { - key: "value", + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, - { + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value", }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - }, - ], + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + }, + model: { + provider: "anthropic", + tools: [ { - key: "value", + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -8925,80 +11513,147 @@ describe("SessionsClient", () => { ",", ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + ], + "tools:append": [ + { type: "apiRequest", messages: [ { @@ -9042,103 +11697,14 @@ describe("SessionsClient", () => { }, ], }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -9166,221 +11732,409 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, ], }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - name: "name", - schema: { - type: "string", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - structuredOutputId: "structuredOutputId", - conditions: [ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, { key: "value", }, ], }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, - }, - model: { - provider: "anthropic", - tools: [ - { + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [ { @@ -9425,38 +12179,69 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -9467,335 +12252,255 @@ describe("SessionsClient", () => { punctuationBoundaries: [ "\u3002", "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - ], - hooks: [ - { - on: "call.ending", - do: [ + fallbackPlan: { + voices: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, }, ], }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, }, - waitSeconds: 3, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", }, }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + { + key: "value", }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + { + key: "value", }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + { + key: "value", }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + ], + }, + }, + }, + }, + messages: [ + { + role: "role", + message: "message", + time: 1.1, + secondsFromStart: 1.1, + }, + ], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { key: "value", @@ -9809,531 +12514,496 @@ describe("SessionsClient", () => { { key: "value", }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], + { + key: "value", }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + { + key: "value", }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, ], - "tools:append": [ + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - key: "value", + type: "request-start", + blocking: false, }, - { + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value", }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ + rejectionPlan: { + conditions: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, ], + name: "name", + schema: { + type: "string", + }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - ], - membersOverrides: { + }, + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -10759,6 +13429,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -10863,322 +13543,239 @@ describe("SessionsClient", () => { }, }, }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", }, - messages: [ - { - role: "role", + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", message: "message", - time: 1.1, - secondsFromStart: 1.1, - }, - ], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", }, - model: { - provider: "anthropic", - tools: [ + description: "description", + }, + hooks: [ + { + on: "call.ringing", + do: [ { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, + type: "transfer", }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, + }, + ], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, - }, - model: "claude-3-opus-20240229", + ], }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, + }, + }, + artifact: { + messages: [ + { + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], + ], + messagesOpenAIFormatted: [ + { + content: null, + role: "assistant", }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + ], + skippedStructuredOutputs: { + key: { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4, }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], + }, + }, + transfers: [ + { + destination: { + type: "number", + number: "number", }, - ], - "tools:append": [ + }, + ], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1, + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [ + { + assistantName: "assistantName", + }, + ], + variableValues: { + key: "value", + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { + key: "value", + }, + scorecards: { + key: "value", + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }); + }); + + test("get", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", + model: { key: "value" }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ { type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], + messages: [{ type: "request-start", blocking: false }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, rejectionPlan: { @@ -11186,27 +13783,69 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + target: { position: -1 }, }, ], }, }, ], - variableValues: { - key: "value", + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -11214,352 +13853,314 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "\u3002", - "\uFF0C", + "。", + "，", ".", "!", "?", ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", + "،", + "۔", + "।", + "॥", "|", "||", ",", ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, }, + waitSeconds: 3, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ { - key: "value", + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", }, ], }, - }, + ], + loggingPath: "loggingPath", }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, - description: "description", }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", - }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, encryptedPaths: ["encryptedPaths"], url: "url", - headers: { - key: "value", - }, + headers: { key: "value" }, backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, }, - }); - }); - - test("get", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - - const rawResponseBody = { - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { key: "value" }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, - }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { + assistantOverrides: { transcriber: { provider: "assembly-ai", language: "multi", @@ -11569,6 +14170,10 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -11623,6 +14228,7 @@ describe("SessionsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -11789,6 +14395,37 @@ describe("SessionsClient", () => { ], }, ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -11886,13 +14523,24 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -11976,30 +14624,19 @@ describe("SessionsClient", () => { type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -12007,280 +14644,207 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - ], - }, + }, + ], }, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", ], - }, - rejectionPlan: { - conditions: [ + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], }, ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -12305,142 +14869,157 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, }, ], }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -12640,8 +15219,38 @@ describe("SessionsClient", () => { ], }, }, - }, - ], + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], compliancePlan: { @@ -12731,6 +15340,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -12820,33 +15433,185 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - model: { - provider: "anthropic", - tools: [ - { + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -12874,28 +15639,50 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -12952,267 +15739,614 @@ describe("SessionsClient", () => { ], }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + }, + }, + }, + }, + messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - on: "call.ending", - do: [ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], - "tools:append": [ + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ + rejectionPlan: { + conditions: [ { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, ], + name: "name", + schema: { type: "string" }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -13230,257 +16364,635 @@ describe("SessionsClient", () => { }, }, }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { mode: "blind-transfer" }, + description: "description", + }, + hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + }, + artifact: { + messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], + messagesOpenAIFormatted: [{ content: null, role: "assistant" }], + skippedStructuredOutputs: { key: { name: "name", unmetCondition: { type: "minMessages", count: 4 } } }, + transfers: [{ destination: { type: "number", number: "number" } }], + recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ assistantName: "assistantName" }], + variableValues: { key: "value" }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { key: "value" }, + scorecards: { key: "value" }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }; + + server.mockEndpoint().get("/session/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.sessions.get({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", model: { - provider: "anthropic", - tools: [ + key: "value", + }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + tools: [ { - on: "call.ending", - do: [ + type: "apiRequest", + messages: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], - "tools:append": [ + toolIds: ["toolIds"], + toolRefs: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", + staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], }, }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -13488,401 +17000,476 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", ], }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", }, }, - }, - messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", }, - model: { - provider: "anthropic", - tools: [ + ], + hooks: [ + { + on: "call.ending", + do: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + name: "name", + schema: { + type: "string", + }, }, - fallbackPlan: { - voices: [ + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], + content: null, + role: "assistant", }, ], - "tools:append": [ + tools: [ { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [ + { + type: "request-start", + blocking: false, + }, + ], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], }, rejectionPlan: { @@ -13890,23 +17477,92 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + target: { + position: -1, + }, }, ], }, }, ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -13914,291 +17570,465 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + type: "request-start", + blocking: false, }, ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, + headers: { + key: "value", + }, backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - }; - - server.mockEndpoint().get("/session/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.sessions.get({ - id: "id", - }); - expect(response).toEqual({ - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { - key: "value", + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [ { + type: "assistant", + assistantName: "assistantName", + }, + ], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -14206,137 +18036,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, - ], + }, + model: "claude-3-opus-20240229", }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -14364,165 +18158,146 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ + fallbackPlan: { + voices: [ { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - ], - }, + }, + ], }, }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], }, - }, - fallbackPlan: { - voices: [ - { + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -14550,202 +18325,185 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, + waitSeconds: 3, + }, }, - name: "name", - schema: { - type: "string", + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", - }, - ], + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], }, - { - key: "value", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - { - key: "value", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - { - key: "value", + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + assistantOverrides: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -14753,137 +18511,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + }, + model: { + provider: "anthropic", + tools: [ { - key: "value", + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + model: "claude-3-opus-20240229", }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -14911,75 +18633,142 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { type: "apiRequest", messages: [ { @@ -15024,344 +18813,443 @@ describe("SessionsClient", () => { ], }, }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, }, - { - key: "value", + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", }, - { - key: "value", + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, - { - key: "value", + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - ], + }, }, - rejectionPlan: { - conditions: [ + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], }, }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + model: "claude-3-opus-20240229", }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ + fallbackPlan: { + voices: [ { - structuredOutputId: "structuredOutputId", - conditions: [ - { - key: "value", + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, ], }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], }, - backoffPlan: { - type: { - key: "value", + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", - }, - ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [ { @@ -15406,38 +19294,69 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -15490,289 +19409,249 @@ describe("SessionsClient", () => { "||", ",", ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], }, - structuredOutputs: [ + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, }, ], + name: "name", + schema: { + type: "string", + }, }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + { + key: "value", }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + messages: [ + { + role: "role", + message: "message", + time: 1.1, + secondsFromStart: 1.1, + }, + ], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -15800,33 +19679,129 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, - }, - model: { - provider: "anthropic", - tools: [ - { + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [ { @@ -15871,38 +19846,69 @@ describe("SessionsClient", () => { ], }, }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -15959,362 +19965,160 @@ describe("SessionsClient", () => { formatPlan: { enabled: true, numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + }, + }, + }, + ], }, }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, }, - structuredOutputs: [ + conditions: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, }, ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + name: "name", + schema: { + type: "string", }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - ], - membersOverrides: { + }, + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -16740,6 +20544,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -16811,355 +20625,272 @@ describe("SessionsClient", () => { }, monitorPlan: { listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - }, - messages: [ - { - role: "role", - message: "message", - time: 1.1, - secondsFromStart: 1.1, - }, - ], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], }, - ], - "tools:append": [ + }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + }, + description: "description", + }, + hooks: [ + { + on: "call.ringing", + do: [ + { + type: "transfer", + }, + ], + }, + ], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + artifact: { + messages: [ + { + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + }, + ], + messagesOpenAIFormatted: [ + { + content: null, + role: "assistant", + }, + ], + skippedStructuredOutputs: { + key: { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4, + }, + }, + }, + transfers: [ + { + destination: { + type: "number", + number: "number", + }, + }, + ], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1, + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [ + { + assistantName: "assistantName", + }, + ], + variableValues: { + key: "value", + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { + key: "value", + }, + scorecards: { + key: "value", + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }); + }); + + test("delete", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", + model: { key: "value" }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ { type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], + messages: [{ type: "request-start", blocking: false }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, rejectionPlan: { @@ -17167,27 +20898,69 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + target: { position: -1 }, }, ], }, }, ], - variableValues: { - key: "value", + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -17195,352 +20968,314 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "\u3002", - "\uFF0C", + "。", + "，", ".", "!", "?", ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", + "،", + "۔", + "।", + "॥", "|", "||", ",", ":", ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, }, + waitSeconds: 3, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ { - key: "value", + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", - }, - description: "description", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - hooks: [ - { - on: "call.ringing", - do: [ - { - type: "transfer", - }, - ], - }, - ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, encryptedPaths: ["encryptedPaths"], url: "url", - headers: { - key: "value", - }, + headers: { key: "value" }, backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - artifact: { - messages: [ - { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, - }, - ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", - }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, - }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { - key: "value", - }, - scorecards: { - key: "value", }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, }, - }); - }); - - test("delete", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - - const rawResponseBody = { - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { key: "value" }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, - }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { + assistantOverrides: { transcriber: { provider: "assembly-ai", language: "multi", @@ -17550,6 +21285,10 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -17604,6 +21343,7 @@ describe("SessionsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -17770,6 +21510,37 @@ describe("SessionsClient", () => { ], }, ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -17867,13 +21638,24 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -17949,38 +21731,27 @@ describe("SessionsClient", () => { server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -17988,280 +21759,207 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - ], - }, + }, + ], }, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", ], - }, - rejectionPlan: { - conditions: [ + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], }, ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -18286,142 +21984,157 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, }, ], }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -18621,8 +22334,38 @@ describe("SessionsClient", () => { ], }, }, - }, - ], + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], compliancePlan: { @@ -18712,6 +22455,10 @@ describe("SessionsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -18801,33 +22548,185 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - model: { - provider: "anthropic", - tools: [ - { + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -18855,28 +22754,50 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -18933,267 +22854,614 @@ describe("SessionsClient", () => { ], }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + }, + }, + }, + }, + messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ { - on: "call.ending", - do: [ + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], - "tools:append": [ + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ + rejectionPlan: { + conditions: [ { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, ], + name: "name", + schema: { type: "string" }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -19211,257 +23479,635 @@ describe("SessionsClient", () => { }, }, }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { mode: "blind-transfer" }, + description: "description", + }, + hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + }, + artifact: { + messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], + messagesOpenAIFormatted: [{ content: null, role: "assistant" }], + skippedStructuredOutputs: { key: { name: "name", unmetCondition: { type: "minMessages", count: 4 } } }, + transfers: [{ destination: { type: "number", number: "number" } }], + recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ assistantName: "assistantName" }], + variableValues: { key: "value" }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { key: "value" }, + scorecards: { key: "value" }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }; + + server.mockEndpoint().delete("/session/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.sessions.delete({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", model: { - provider: "anthropic", - tools: [ + key: "value", + }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + tools: [ { - on: "call.ending", - do: [ + type: "apiRequest", + messages: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", + staticIpAddressesEnabled: false, backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], }, }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -19469,401 +24115,476 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", ], }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", }, }, - }, - messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", }, - model: { - provider: "anthropic", - tools: [ + ], + hooks: [ + { + on: "call.ending", + do: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + name: "name", + schema: { + type: "string", + }, }, - fallbackPlan: { - voices: [ + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, - ], + content: null, + role: "assistant", }, ], - "tools:append": [ + tools: [ { type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], + messages: [ + { + type: "request-start", + blocking: false, + }, + ], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], }, rejectionPlan: { @@ -19871,23 +24592,92 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + target: { + position: -1, + }, }, ], }, }, ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -19895,291 +24685,465 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - fallbackPlan: { - voices: [ + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + type: "request-start", + blocking: false, }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + type: "request-start", + blocking: false, }, ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, ], + name: "name", + schema: { + type: "string", + }, }, - }, - }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - }; - - server.mockEndpoint().delete("/session/id").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); - - const response = await client.sessions.delete({ - id: "id", - }); - expect(response).toEqual({ - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value", }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [ { + type: "assistant", + assistantName: "assistantName", + }, + ], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -20187,137 +25151,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -20345,165 +25273,146 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ + fallbackPlan: { + voices: [ { - type: "request-start", - blocking: false, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, }, ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, - ], - }, - }, - }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + }, + ], }, - }, - fallbackPlan: { - voices: [ - { + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -20531,202 +25440,185 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, ], }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - name: "name", - schema: { - type: "string", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, { key: "value", }, ], }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + }, + assistantOverrides: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -20734,137 +25626,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, - ], + }, + model: "claude-3-opus-20240229", }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -20892,75 +25748,142 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { type: "apiRequest", messages: [ { @@ -21005,102 +25928,13 @@ describe("SessionsClient", () => { ], }, }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -21128,272 +25962,420 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, ], }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, { key: "value", }, ], }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, + }, }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", }, - backoffPlan: { - type: { - key: "value", + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ + model: { + provider: "anthropic", + tools: [ { - type: "assistant", - assistantName: "assistantName", + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], }, }, - model: { - provider: "anthropic", - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { key: "value", @@ -21415,10 +26397,81 @@ describe("SessionsClient", () => { }, ], }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, }, - model: "claude-3-opus-20240229", + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -21473,287 +26526,247 @@ describe("SessionsClient", () => { ":", ], formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, - }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + ], }, }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, }, - structuredOutputs: [ + conditions: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, }, ], + name: "name", + schema: { + type: "string", + }, }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + { + key: "value", }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + messages: [ + { + role: "role", + message: "message", + time: 1.1, + secondsFromStart: 1.1, + }, + ], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -21781,84 +26794,140 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, - ], + }, }, - }, - model: { - provider: "anthropic", - tools: [ - { + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [ { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { + type: "request-start", + blocking: false, + }, + ], + method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, + url: "url", backoffPlan: { type: { key: "value", @@ -21876,426 +26945,295 @@ describe("SessionsClient", () => { key: "value", }, { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + key: "value", + }, + ], }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, }, - waitSeconds: 3, }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", }, }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", + { + key: "value", }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + { + key: "value", }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + { + key: "value", }, - }, + ], }, }, - ], - membersOverrides: { + }, + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -22721,6 +27659,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -22806,341 +27754,696 @@ describe("SessionsClient", () => { type: { key: "value", }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { + mode: "blind-transfer", + }, + description: "description", + }, + hooks: [ + { + on: "call.ringing", + do: [ + { + type: "transfer", + }, + ], + }, + ], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + artifact: { + messages: [ + { + role: "role", + message: "message", + time: 1.1, + endTime: 1.1, + secondsFromStart: 1.1, + }, + ], + messagesOpenAIFormatted: [ + { + content: null, + role: "assistant", + }, + ], + skippedStructuredOutputs: { + key: { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4, + }, + }, + }, + transfers: [ + { + destination: { + type: "number", + number: "number", }, }, + ], + recording: { + stereoUrl: "stereoUrl", + videoUrl: "videoUrl", + videoRecordingStartDelaySeconds: 1.1, + }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [ + { + assistantName: "assistantName", + }, + ], + variableValues: { + key: "value", + }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, }, + structuredOutputs: { + key: "value", + }, + scorecards: { + key: "value", + }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", }, - messages: [ + }); + }); + + test("update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ { - role: "role", - message: "message", - time: 1.1, - secondsFromStart: 1.1, + type: "model", + model: { key: "value" }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, }, ], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - ], - }, + }, + ], }, - model: { - provider: "anthropic", - tools: [ + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, }, - }, - model: "claude-3-opus-20240229", + ], }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, - numberToDigitsCutoff: 2025, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, - }, - ], + ], + }, }, + waitSeconds: 3, }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - tags: ["tags"], + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - credentials: [ + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ { - provider: "11labs", - apiKey: "apiKey", + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, }, ], - hooks: [ + scorecardIds: ["scorecardIds"], + scorecards: [ { - on: "call.ending", - do: [ + metrics: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, - }, + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", }, ], }, ], - "tools:append": [ + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ { type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], + messages: [{ type: "request-start", blocking: false }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { - key: "value", - }, + type: { key: "value" }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, rejectionPlan: { @@ -23148,398 +28451,422 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + target: { position: -1 }, }, ], }, }, ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { - mode: "blind-transfer", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - description: "description", - }, - hooks: [ - { - on: "call.ringing", - do: [ + speed: 1.1, + fallbackPlan: { + voices: [ { - type: "transfer", + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, }, ], }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", ], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ { - key: "value", + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, }, ], }, - }, - }, - artifact: { - messages: [ + ], + "tools:append": [ { - role: "role", - message: "message", - time: 1.1, - endTime: 1.1, - secondsFromStart: 1.1, + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], - messagesOpenAIFormatted: [ - { - content: null, - role: "assistant", + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, }, - ], - recording: { - stereoUrl: "stereoUrl", - videoUrl: "videoUrl", - videoRecordingStartDelaySeconds: 1.1, }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [ - { - assistantName: "assistantName", + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - ], - variableValues: { - key: "value", - }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, }, - structuredOutputs: { - key: "value", + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", }, - scorecards: { - key: "value", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - }); - }); - - test("update", async () => { - const server = mockServerPool.createServer(); - const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); - const rawRequestBody = {}; - const rawResponseBody = { - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { key: "value" }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -23547,249 +28874,207 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, }, + model: "claude-3-opus-20240229", }, - ], - }, - ], - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, }, - fallbackPlan: { - voices: [ - { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -23814,254 +29099,233 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, }, ], }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], - }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [{ content: null, role: "assistant" }], - tools: [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", ], }, - rejectionPlan: { - conditions: [ + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, }, ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { type: "enabled", budgetTokens: 1.1 }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -24086,62 +29350,111 @@ describe("SessionsClient", () => { ], formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { key: "value" }, - }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -24169,266 +29482,366 @@ describe("SessionsClient", () => { ], }, }, - }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, }, - ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { key: "value" }, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], }, - }, - keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], - assistant: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - model: { - provider: "anthropic", - tools: [ - { + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -24456,28 +29869,50 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -24500,271 +29935,223 @@ describe("SessionsClient", () => { "||", ",", ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, ], }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], - }, - }, - waitSeconds: 3, + }, + }, + }, + }, + messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -24782,33 +30169,109 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, }, - }, - model: { - provider: "anthropic", - tools: [ - { + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { type: "apiRequest", messages: [{ type: "request-start", blocking: false }], method: "POST", @@ -24836,28 +30299,50 @@ describe("SessionsClient", () => { ], }, }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, - }, - model: "claude-3-opus-20240229", + ], }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", voice: { provider: "azure", cachingEnabled: true, @@ -24881,544 +30366,777 @@ describe("SessionsClient", () => { ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + squadOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, - }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], - "tools:append": [ + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, }, ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, }, - waitSeconds: 3, - }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ + rejectionPlan: { + conditions: [ { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, }, ], }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, ], + name: "name", + schema: { type: "string" }, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - ], - membersOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, ], }, }, + }, + number: "number", + sipUri: "sipUri", + name: "name", + email: "email", + externalId: "externalId", + }, + customerId: "customerId", + phoneNumberId: "phoneNumberId", + phoneNumber: { + fallbackDestination: { + type: "number", + message: "message", + numberE164CheckEnabled: true, + number: "number", + extension: "extension", + callerId: "callerId", + transferPlan: { mode: "blind-transfer" }, + description: "description", + }, + hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], + smsEnabled: true, + twilioPhoneNumber: "twilioPhoneNumber", + twilioAccountSid: "twilioAccountSid", + twilioAuthToken: "twilioAuthToken", + twilioApiKey: "twilioApiKey", + twilioApiSecret: "twilioApiSecret", + name: "name", + assistantId: "assistantId", + workflowId: "workflowId", + squadId: "squadId", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + }, + artifact: { + messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], + messagesOpenAIFormatted: [{ content: null, role: "assistant" }], + skippedStructuredOutputs: { key: { name: "name", unmetCondition: { type: "minMessages", count: 4 } } }, + transfers: [{ destination: { type: "number", number: "number" } }], + recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, + transcript: "transcript", + pcapUrl: "pcapUrl", + logUrl: "logUrl", + nodes: [{}], + assistantActivations: [{ assistantName: "assistantName" }], + variableValues: { key: "value" }, + performanceMetrics: { + turnLatencies: [{}], + modelLatencyAverage: 1.1, + voiceLatencyAverage: 1.1, + transcriberLatencyAverage: 1.1, + endpointingLatencyAverage: 1.1, + turnLatencyAverage: 1.1, + fromTransportLatencyAverage: 1.1, + toTransportLatencyAverage: 1.1, + numUserInterrupted: 1.1, + numAssistantInterrupted: 1.1, + }, + structuredOutputs: { key: "value" }, + scorecards: { key: "value" }, + structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", + }, + }; + + server + .mockEndpoint() + .patch("/session/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.sessions.update({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + cost: 1.1, + costs: [ + { + type: "model", model: { - provider: "anthropic", - tools: [ + key: "value", + }, + promptTokens: 1.1, + completionTokens: 1.1, + cachedPromptTokens: 1.1, + reasoningTokens: 1.1, + cost: 1.1, + }, + ], + name: "name", + status: "active", + expirationSeconds: 86400, + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ + tools: [ { - on: "call.ending", - do: [ + type: "apiRequest", + messages: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, - ], - }, - }, + type: "request-start", + blocking: false, }, ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", url: "url", backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], }, rejectionPlan: { @@ -25426,23 +31144,92 @@ describe("SessionsClient", () => { { type: "regex", regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", }, ], }, }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -25450,706 +31237,403 @@ describe("SessionsClient", () => { enabled: true, minCharacters: 30, punctuationBoundaries: [ - "。", - "，", + "\u3002", + "\uFF0C", ".", "!", "?", ";", - "،", - "۔", - "।", - "॥", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", "|", "||", ",", ":", ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - }, - ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, - }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", ], }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", }, }, - }, - messages: [{ role: "role", message: "message", time: 1.1, secondsFromStart: 1.1 }], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], - }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", }, - model: { - provider: "anthropic", - tools: [ + ], + hooks: [ + { + on: "call.ending", + do: [ { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + type: "request-start", + blocking: false, }, ], - }, - }, - ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, - }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], - observabilityPlan: { provider: "langfuse", tags: ["tags"] }, - credentials: [{ provider: "11labs", apiKey: "apiKey" }], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, - ], - }, + }, + ], }, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [{ type: "request-start", blocking: false }], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, - ], }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { position: -1 }, - }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", ], - }, - }, - ], - variableValues: { key: "value" }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + numberToDigitsCutoff: 2025, }, - fallbackPlan: { - voices: [ - { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "。", - "，", - ".", - "!", - "?", - ";", - "،", - "۔", - "।", - "॥", - "|", - "||", - ",", - ":", - ], - formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + numberToDigitsCutoff: 2025, }, }, - ], - }, - }, - waitSeconds: 3, - }, - }, - metadata: { key: "value" }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { enabled: true }, - structuredOutputs: [ - { - compliancePlan: { forceStoreOnHipaaEnabled: false }, - name: "name", - schema: { type: "string" }, + }, + ], }, - ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { provider: "vapi" }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, }, + waitSeconds: 3, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { key: "value" }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { key: "value" }, - { key: "value" }, - { key: "value" }, - { key: "value" }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, ], }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, }, }, - number: "number", - sipUri: "sipUri", - name: "name", - email: "email", - externalId: "externalId", - }, - customerId: "customerId", - phoneNumberId: "phoneNumberId", - phoneNumber: { - fallbackDestination: { - type: "number", - message: "message", - numberE164CheckEnabled: true, - number: "number", - extension: "extension", - callerId: "callerId", - transferPlan: { mode: "blind-transfer" }, - description: "description", + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], }, - hooks: [{ on: "call.ringing", do: [{ type: "transfer" }] }], - smsEnabled: true, - twilioPhoneNumber: "twilioPhoneNumber", - twilioAccountSid: "twilioAccountSid", - twilioAuthToken: "twilioAuthToken", - twilioApiKey: "twilioApiKey", - twilioApiSecret: "twilioApiSecret", - name: "name", - assistantId: "assistantId", - workflowId: "workflowId", - squadId: "squadId", + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], server: { timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", staticIpAddressesEnabled: false, encryptedPaths: ["encryptedPaths"], url: "url", - headers: { key: "value" }, + headers: { + key: "value", + }, backoffPlan: { - type: { key: "value" }, + type: { + key: "value", + }, maxRetries: 0, baseDelaySeconds: 1, - excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - }, - artifact: { - messages: [{ role: "role", message: "message", time: 1.1, endTime: 1.1, secondsFromStart: 1.1 }], - messagesOpenAIFormatted: [{ content: null, role: "assistant" }], - recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", videoRecordingStartDelaySeconds: 1.1 }, - transcript: "transcript", - pcapUrl: "pcapUrl", - logUrl: "logUrl", - nodes: [{}], - assistantActivations: [{ assistantName: "assistantName" }], - variableValues: { key: "value" }, - performanceMetrics: { - turnLatencies: [{}], - modelLatencyAverage: 1.1, - voiceLatencyAverage: 1.1, - transcriberLatencyAverage: 1.1, - endpointingLatencyAverage: 1.1, - turnLatencyAverage: 1.1, - fromTransportLatencyAverage: 1.1, - toTransportLatencyAverage: 1.1, - numUserInterrupted: 1.1, - numAssistantInterrupted: 1.1, - }, - structuredOutputs: { key: "value" }, - scorecards: { key: "value" }, - transfers: ["transfers"], - structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", - }, - }; - - server - .mockEndpoint() - .patch("/session/id") - .jsonBody(rawRequestBody) - .respondWith() - .statusCode(200) - .jsonBody(rawResponseBody) - .build(); - - const response = await client.sessions.update({ - id: "id", - }); - expect(response).toEqual({ - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - cost: 1.1, - costs: [ - { - type: "model", - model: { - key: "value", - }, - promptTokens: 1.1, - completionTokens: 1.1, - cachedPromptTokens: 1.1, - cost: 1.1, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", }, - ], - name: "name", - status: "active", - expirationSeconds: 86400, - assistantId: "assistantId", - assistant: { + }, + assistantOverrides: { transcriber: { provider: "assembly-ai", language: "multi", @@ -26159,6 +31643,10 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -26235,6 +31723,12 @@ describe("SessionsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -26450,6 +31944,56 @@ describe("SessionsClient", () => { ], }, ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, name: "name", voicemailMessage: "voicemailMessage", endCallMessage: "endCallMessage", @@ -26559,6 +32103,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -26570,12 +32124,15 @@ describe("SessionsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -26696,25 +32253,19 @@ describe("SessionsClient", () => { delimiters: "#", }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - language: "multi", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - speechModel: "universal-streaming-english", - realtimeUrl: "realtimeUrl", - wordBoost: ["wordBoost"], - keytermsPrompt: ["keytermsPrompt"], - endUtteranceSilenceThreshold: 1.1, - disablePartialTranscripts: true, - fallbackPlan: { - transcribers: [ + squadId: "squadId", + squad: { + name: "name", + members: [ + { + assistantDestinations: [ { + type: "assistant", + assistantName: "assistantName", + }, + ], + assistant: { + transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, formatTurns: true, @@ -26722,137 +32273,101 @@ describe("SessionsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, - }, - ], - }, - }, - model: { - provider: "anthropic", - messages: [ - { - content: null, - role: "assistant", - }, - ], - tools: [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], }, - rejectionPlan: { - conditions: [ + model: { + provider: "anthropic", + tools: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], }, }, ], - }, - }, - ], - toolIds: ["toolIds"], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, }, - ], + }, + model: "claude-3-opus-20240229", }, - }, - }, - model: "claude-3-opus-20240229", - thinking: { - type: "enabled", - budgetTokens: 1.1, - }, - temperature: 1.1, - maxTokens: 1.1, - emotionRecognitionEnabled: true, - numFastTurns: 1.1, - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - speed: 1.1, - fallbackPlan: { - voices: [ - { + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -26880,215 +32395,146 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - firstMessageInterruptionsEnabled: true, - firstMessageMode: "assistant-speaks-first", - voicemailDetection: "off", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - observabilityPlan: { - provider: "langfuse", - promptName: "promptName", - promptVersion: 1.1, - traceName: "traceName", - tags: ["tags"], - metadata: { - key: "value", - }, - }, - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", - }, - ], - hooks: [ - { - on: "call.ending", - do: [ - { - type: "tool", - tool: { - type: "apiRequest", - messages: [ + fallbackPlan: { + voices: [ { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, }, }, - ], - }, + }, + ], }, }, - ], - }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ { - key: "value", + provider: "twilio", + timeout: 60, + record: false, }, + ], + credentials: [ { - key: "value", + provider: "11labs", + apiKey: "apiKey", }, ], - }, - rejectionPlan: { - conditions: [ + hooks: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], }, ], - }, - }, - ], - variableValues: { - key: "value", - }, - name: "name", - voicemailMessage: "voicemailMessage", - endCallMessage: "endCallMessage", - endCallPhrases: ["endCallPhrases"], - compliancePlan: { - hipaaEnabled: true, - pciEnabled: true, - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - fallbackPlan: { - voices: [ - { + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { provider: "azure", cachingEnabled: true, voiceId: "andrew", @@ -27116,195 +32562,184 @@ describe("SessionsClient", () => { numberToDigitsCutoff: 2025, }, }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, }, ], }, - }, - waitSeconds: 3, - }, - }, - metadata: { - key: "value", - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, - }, - }, - artifactPlan: { - recordingEnabled: true, - recordingFormat: "wav;l16", - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { - enabled: true, - }, - recordingPath: "recordingPath", - structuredOutputIds: ["structuredOutputIds"], - structuredOutputs: [ - { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], }, - }, - ], - scorecardIds: ["scorecardIds"], - scorecards: [ - { - metrics: [ - { - structuredOutputId: "structuredOutputId", - conditions: [ + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, { key: "value", }, ], }, - ], - }, - ], - loggingPath: "loggingPath", - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - customEndpointingRules: [ - { - type: "assistant", - regex: "regex", - timeoutSeconds: 1.1, - }, - ], - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, - }, - }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], - }, - credentialIds: ["credentialIds"], - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - encryptedPaths: ["encryptedPaths"], - url: "url", - headers: { - key: "value", - }, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - keypadInputPlan: { - enabled: true, - timeoutSeconds: 1.1, - delimiters: "#", - }, - }, - squadId: "squadId", - squad: { - name: "name", - members: [ - { - assistantDestinations: [ - { - type: "assistant", - assistantName: "assistantName", }, - ], - assistant: { + }, + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -27565,8 +33000,55 @@ describe("SessionsClient", () => { ], }, }, - }, - ], + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, }, ], compliancePlan: { @@ -27666,6 +33148,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -27769,521 +33261,561 @@ describe("SessionsClient", () => { }, }, }, - assistantOverrides: { - transcriber: { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - fallbackPlan: { - transcribers: [ - { - provider: "assembly-ai", - confidenceThreshold: 0.4, - formatTurns: true, - endOfTurnConfidenceThreshold: 0.7, - minEndOfTurnSilenceWhenConfident: 160, - maxTurnSilence: 400, - vadAssistedEndpointingEnabled: true, - }, - ], + }, + ], + membersOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, }, - }, - model: { - provider: "anthropic", - tools: [ + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, + type: "request-start", + blocking: false, }, ], - knowledgeBase: { - provider: "custom-knowledge-base", - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - }, - }, - model: "claude-3-opus-20240229", - }, - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", }, - }, - fallbackPlan: { - voices: [ + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, - }, - }, - ], - }, - }, - firstMessage: "Hello! How can I help you today?", - clientMessages: [ - "conversation-update", - "function-call", - "hang", - "model-output", - "speech-update", - "status-update", - "transfer-update", - "transcript", - "tool-calls", - "user-interrupted", - "voice-input", - "workflow.node.started", - "assistant.started", - ], - serverMessages: [ - "conversation-update", - "end-of-call-report", - "function-call", - "hang", - "speech-update", - "status-update", - "tool-calls", - "transfer-destination-request", - "handoff-destination-request", - "user-interrupted", - "assistant.started", - ], - maxDurationSeconds: 600, - backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", - modelOutputInMessagesEnabled: false, - transportConfigurations: [ - { - provider: "twilio", - timeout: 60, - record: false, - }, - ], - credentials: [ - { - provider: "11labs", - apiKey: "apiKey", + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - ], - hooks: [ - { - on: "call.ending", - do: [ + rejectionPlan: { + conditions: [ { - type: "tool", - tool: { - type: "apiRequest", - messages: [ - { - type: "request-start", - blocking: false, - }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], - }, - rejectionPlan: { - conditions: [ - { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, - }, - ], - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, - ], - "tools:append": [ - { - type: "apiRequest", - messages: [ + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ { - type: "request-start", - blocking: false, + key: "value", }, - ], - method: "POST", - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - url: "url", - backoffPlan: { - type: { + { key: "value", }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, }, - rejectionPlan: { - conditions: [ + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ { - type: "regex", - regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", - target: { - position: -1, - }, + type: "request-start", + blocking: false, }, ], - }, - }, - ], - compliancePlan: { - recordingConsentPlan: { - type: "stay-on-line", - message: - "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", - voice: { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - fallbackPlan: { - voices: [ + rejectionPlan: { + conditions: [ { - provider: "azure", - cachingEnabled: true, - voiceId: "andrew", - chunkPlan: { - enabled: true, - minCharacters: 30, - punctuationBoundaries: [ - "\u3002", - "\uFF0C", - ".", - "!", - "?", - ";", - "\u060C", - "\u06D4", - "\u0964", - "\u0965", - "|", - "||", - ",", - ":", - ], - formatPlan: { - enabled: true, - numberToDigitsCutoff: 2025, - }, + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, }, }, ], }, }, - waitSeconds: 3, }, - }, - backgroundSpeechDenoisingPlan: { - fourierDenoisingPlan: { - mediaDetectionEnabled: true, - staticThreshold: -35, - baselineOffsetDb: -15, - windowSizeMs: 3000, - baselinePercentile: 85, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, - artifactPlan: { - recordingEnabled: true, - recordingUseCustomStorageEnabled: true, - videoRecordingEnabled: false, - fullMessageHistoryEnabled: false, - pcapEnabled: true, - pcapS3PathPrefix: "/pcaps", - pcapUseCustomStorageEnabled: true, - loggingEnabled: true, - loggingUseCustomStorageEnabled: true, - transcriptPlan: { + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, }, - structuredOutputs: [ + conditions: [ { - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - name: "name", - schema: { - type: "string", - }, + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, }, ], - }, - startSpeakingPlan: { - waitSeconds: 0.4, - smartEndpointingPlan: { - provider: "vapi", - }, - transcriptionEndpointingPlan: { - onPunctuationSeconds: 0.1, - onNoPunctuationSeconds: 1.5, - onNumberSeconds: 0.5, + name: "name", + schema: { + type: "string", }, }, - stopSpeakingPlan: { - numWords: 0, - voiceSeconds: 0.2, - backoffSeconds: 1, - acknowledgementPhrases: [ - "i understand", - "i see", - "i got it", - "i hear you", - "im listening", - "im with you", - "right", - "okay", - "ok", - "sure", - "alright", - "got it", - "understood", - "yeah", - "yes", - "uh-huh", - "mm-hmm", - "gotcha", - "mhmm", - "ah", - "yeah okay", - "yeah sure", - ], - interruptionPhrases: [ - "stop", - "shut", - "up", - "enough", - "quiet", - "silence", - "but", - "dont", - "not", - "no", - "hold", - "wait", - "cut", - "pause", - "nope", - "nah", - "nevermind", - "never", - "bad", - "actually", - ], - }, - monitorPlan: { - listenEnabled: false, - listenAuthenticationEnabled: false, - controlEnabled: false, - controlAuthenticationEnabled: false, - monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", }, - server: { - timeoutSeconds: 20, - credentialId: "550e8400-e29b-41d4-a716-446655440000", - staticIpAddressesEnabled: false, - backoffPlan: { - type: { - key: "value", - }, - maxRetries: 0, - baseDelaySeconds: 1, - excludedStatusCodes: [ - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - { - key: "value", - }, - ], + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", }, - }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], }, }, - ], - membersOverrides: { + }, + }, + messages: [ + { + role: "role", + message: "message", + time: 1.1, + secondsFromStart: 1.1, + }, + ], + customer: { + numberE164CheckEnabled: true, + extension: "extension", + assistantOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -28709,6 +34241,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -28813,19 +34355,7 @@ describe("SessionsClient", () => { }, }, }, - }, - messages: [ - { - role: "role", - message: "message", - time: 1.1, - secondsFromStart: 1.1, - }, - ], - customer: { - numberE164CheckEnabled: true, - extension: "extension", - assistantOverrides: { + squadOverrides: { transcriber: { provider: "assembly-ai", confidenceThreshold: 0.4, @@ -29251,6 +34781,16 @@ describe("SessionsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -29444,6 +34984,23 @@ describe("SessionsClient", () => { role: "assistant", }, ], + skippedStructuredOutputs: { + key: { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4, + }, + }, + }, + transfers: [ + { + destination: { + type: "number", + number: "number", + }, + }, + ], recording: { stereoUrl: "stereoUrl", videoUrl: "videoUrl", @@ -29479,8 +35036,15 @@ describe("SessionsClient", () => { scorecards: { key: "value", }, - transfers: ["transfers"], structuredOutputsLastUpdatedAt: "2024-01-15T09:30:00Z", + presignedMonoUrl: "presignedMonoUrl", + presignedStereoUrl: "presignedStereoUrl", + presignedVideoUrl: "presignedVideoUrl", + presignedAssistantUrl: "presignedAssistantUrl", + presignedCustomerUrl: "presignedCustomerUrl", + presignedPcapUrl: "presignedPcapUrl", + presignedLogUrl: "presignedLogUrl", + presignedUrlsExpiresAt: "presignedUrlsExpiresAt", }, }); }); diff --git a/tests/wire/simulationPersonalities.test.ts b/tests/wire/simulationPersonalities.test.ts new file mode 100644 index 00000000..9f5f7ec8 --- /dev/null +++ b/tests/wire/simulationPersonalities.test.ts @@ -0,0 +1,5097 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("SimulationPersonalitiesClient", () => { + test("PersonalityController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + path: "path", + }, + ]; + + server + .mockEndpoint() + .get("/eval/simulation/personality") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationPersonalities.personalityControllerFindAll(); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + path: "path", + }, + ]); + }); + + test("PersonalityController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { name: "name", assistant: {} }; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + path: "path", + }; + + server + .mockEndpoint() + .post("/eval/simulation/personality") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationPersonalities.personalityControllerCreate({ + name: "name", + assistant: {}, + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + path: "path", + }); + }); + + test("PersonalityController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + path: "path", + }; + + server + .mockEndpoint() + .get("/eval/simulation/personality/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationPersonalities.personalityControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + path: "path", + }); + }); + + test("PersonalityController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + path: "path", + }; + + server + .mockEndpoint() + .delete("/eval/simulation/personality/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationPersonalities.personalityControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + path: "path", + }); + }); + + test("PersonalityController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + path: "path", + }; + + server + .mockEndpoint() + .patch("/eval/simulation/personality/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationPersonalities.personalityControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + path: "path", + }); + }); +}); diff --git a/tests/wire/simulationRuns.test.ts b/tests/wire/simulationRuns.test.ts new file mode 100644 index 00000000..6eef6f47 --- /dev/null +++ b/tests/wire/simulationRuns.test.ts @@ -0,0 +1,12303 @@ +// This file was auto-generated by Fern from our API Definition. + +import * as Vapi from "../../src/api/index"; +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("SimulationRunsClient", () => { + test("SimulationRunController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { provider: "vapi.websocket" }, + }, + ]; + + server + .mockEndpoint() + .get("/eval/simulation/run") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerFindAll(); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { + provider: "vapi.websocket", + }, + }, + ]); + }); + + test("SimulationRunController_create (1)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { simulations: [{ type: "simulation" }], target: { type: "assistant" } }; + const rawResponseBody = { + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { provider: "vapi.websocket" }, + simulationRunItemIds: ["simulationRunItemIds"], + message: "message", + url: "url", + }; + + server + .mockEndpoint() + .post("/eval/simulation/run") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerCreate({ + simulations: [ + { + type: "simulation", + }, + ], + target: { + type: "assistant", + }, + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { + provider: "vapi.websocket", + }, + simulationRunItemIds: ["simulationRunItemIds"], + message: "message", + url: "url", + }); + }); + + test("SimulationRunController_create (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { + simulations: [{ type: "simulation" }, { type: "simulation" }], + target: { type: "assistant" }, + }; + const rawResponseBody = { statusCode: 1.1, message: "message", reason: "wallet_missing" }; + + server + .mockEndpoint() + .post("/eval/simulation/run") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(402) + .jsonBody(rawResponseBody) + .build(); + + await expect(async () => { + return await client.simulationRuns.simulationRunControllerCreate({ + simulations: [ + { + type: "simulation", + }, + { + type: "simulation", + }, + ], + target: { + type: "assistant", + }, + }); + }).rejects.toThrow(Vapi.PaymentRequiredError); + }); + + test("SimulationRunController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { provider: "vapi.websocket" }, + }; + + server + .mockEndpoint() + .get("/eval/simulation/run/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { + provider: "vapi.websocket", + }, + }); + }); + + test("SimulationRunController_cancelGroup", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { provider: "vapi.websocket" }, + }; + + server + .mockEndpoint() + .patch("/eval/simulation/run/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerCancelGroup({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + endedAt: "2024-01-15T09:30:00Z", + endedReason: "endedReason", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + itemCounts: { + total: 1.1, + passed: 1.1, + failed: 1.1, + running: 1.1, + queued: 1.1, + canceled: 1.1, + distinctSimulationTotal: 1.1, + distinctSimulationFailed: 1.1, + }, + simulations: [ + { + type: "simulation", + simulationId: "simulationId", + scenarioId: "scenarioId", + scenario: { + name: "Health Enrollment - Eligible Path", + instructions: + "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + personalityId: "personalityId", + personality: { + name: "name", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + name: "name", + }, + ], + target: { + type: "assistant", + assistantId: "assistantId", + assistant: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + }, + iterations: 1.1, + transport: { + provider: "vapi.websocket", + }, + }); + }); + + test("SimulationRunController_findItems", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { key: "value" }, + squad: { key: "value" }, + scenario: { key: "value" }, + personality: { key: "value" }, + simulation: { key: "value" }, + hooks: { key: "value" }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { turnCount: 1.1 }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + toolSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + scenarioSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { transport: { provider: "vapi.websocket" } }, + }, + ]; + + server + .mockEndpoint() + .get("/eval/simulation/run/id/item") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerFindItems({ + id: "id", + }); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { + key: "value", + }, + squad: { + key: "value", + }, + scenario: { + key: "value", + }, + personality: { + key: "value", + }, + simulation: { + key: "value", + }, + hooks: { + key: "value", + }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { + turnCount: 1.1, + }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + toolSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + scenarioSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { + transport: { + provider: "vapi.websocket", + }, + }, + }, + ]); + }); + + test("SimulationRunController_findItem", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { key: "value" }, + squad: { key: "value" }, + scenario: { key: "value" }, + personality: { key: "value" }, + simulation: { key: "value" }, + call: { transcript: "transcript", messages: [{ key: "value" }], recordingUrl: "recordingUrl" }, + hooks: { key: "value" }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { + turnCount: 1.1, + avgTurn: 1.1, + avgTranscriber: 1.1, + avgModel: 1.1, + avgVoice: 1.1, + avgEndpointing: 1.1, + }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + toolSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + scenarioSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { transport: { provider: "vapi.websocket" } }, + }; + + server + .mockEndpoint() + .get("/eval/simulation/run/id/item/itemId") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerFindItem({ + id: "id", + itemId: "itemId", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { + key: "value", + }, + squad: { + key: "value", + }, + scenario: { + key: "value", + }, + personality: { + key: "value", + }, + simulation: { + key: "value", + }, + call: { + transcript: "transcript", + messages: [ + { + key: "value", + }, + ], + recordingUrl: "recordingUrl", + }, + hooks: { + key: "value", + }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { + turnCount: 1.1, + avgTurn: 1.1, + avgTranscriber: 1.1, + avgModel: 1.1, + avgVoice: 1.1, + avgEndpointing: 1.1, + }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + toolSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + scenarioSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { + transport: { + provider: "vapi.websocket", + }, + }, + }); + }); + + test("SimulationRunController_cancelItem", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { key: "value" }, + squad: { key: "value" }, + scenario: { key: "value" }, + personality: { key: "value" }, + simulation: { key: "value" }, + call: { transcript: "transcript", messages: [{ key: "value" }], recordingUrl: "recordingUrl" }, + hooks: { key: "value" }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { + turnCount: 1.1, + avgTurn: 1.1, + avgTranscriber: 1.1, + avgModel: 1.1, + avgVoice: 1.1, + avgEndpointing: 1.1, + }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + toolSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + scenarioSuggestions: [{ issue: "issue", suggestion: "suggestion" }], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { transport: { provider: "vapi.websocket" } }, + }; + + server + .mockEndpoint() + .patch("/eval/simulation/run/id/item/itemId") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationRuns.simulationRunControllerCancelItem({ + id: "id", + itemId: "itemId", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + simulationId: "simulationId", + status: "queued", + queuedAt: "2024-01-15T09:30:00Z", + startedAt: "2024-01-15T09:30:00Z", + completedAt: "2024-01-15T09:30:00Z", + failedAt: "2024-01-15T09:30:00Z", + canceledAt: "2024-01-15T09:30:00Z", + failureReason: "failureReason", + callId: "callId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + runId: "runId", + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + iterationNumber: 1.1, + sessionId: "sessionId", + scenarioId: "scenarioId", + personalityId: "personalityId", + metadata: { + assistant: { + key: "value", + }, + squad: { + key: "value", + }, + scenario: { + key: "value", + }, + personality: { + key: "value", + }, + simulation: { + key: "value", + }, + call: { + transcript: "transcript", + messages: [ + { + key: "value", + }, + ], + recordingUrl: "recordingUrl", + }, + hooks: { + key: "value", + }, + }, + results: { + evaluations: [ + { + structuredOutputId: "structuredOutputId", + name: "name", + extractedValue: null, + expectedValue: 1.1, + comparator: "=", + passed: true, + required: true, + }, + ], + passed: true, + latencyMetrics: { + turnCount: 1.1, + avgTurn: 1.1, + avgTranscriber: 1.1, + avgModel: 1.1, + avgVoice: 1.1, + avgEndpointing: 1.1, + }, + }, + improvementSuggestions: { + analysis: "analysis", + systemPromptSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + toolSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + scenarioSuggestions: [ + { + issue: "issue", + suggestion: "suggestion", + }, + ], + suggestedSystemPrompt: "suggestedSystemPrompt", + }, + configurations: { + transport: { + provider: "vapi.websocket", + }, + }, + }); + }); + + test("SimulationRunController_generateSuggestions", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + server + .mockEndpoint() + .post("/eval/simulation/run/id/item/itemId/generate") + .respondWith() + .statusCode(200) + .build(); + + const response = await client.simulationRuns.simulationRunControllerGenerateSuggestions({ + id: "id", + itemId: "itemId", + force: "force", + }); + expect(response).toEqual(undefined); + }); +}); diff --git a/tests/wire/simulationScenarios.test.ts b/tests/wire/simulationScenarios.test.ts new file mode 100644 index 00000000..08b8ded0 --- /dev/null +++ b/tests/wire/simulationScenarios.test.ts @@ -0,0 +1,6096 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("SimulationScenariosClient", () => { + test("ScenarioController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { provider: "langfuse", tags: ["tags"] }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + toolMocks: [{ toolName: "toolName" }], + path: "path", + }, + ]; + + server + .mockEndpoint() + .get("/eval/simulation/scenario") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationScenarios.scenarioControllerFindAll(); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + tags: ["tags"], + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + toolMocks: [ + { + toolName: "toolName", + }, + ], + path: "path", + }, + ]); + }); + + test("ScenarioController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [{ comparator: "=", value: 1.1 }], + }; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + toolMocks: [{ toolName: "toolName", result: "result", enabled: true }], + path: "path", + }; + + server + .mockEndpoint() + .post("/eval/simulation/scenario") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationScenarios.scenarioControllerCreate({ + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + comparator: "=", + value: 1.1, + }, + ], + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + toolMocks: [ + { + toolName: "toolName", + result: "result", + enabled: true, + }, + ], + path: "path", + }); + }); + + test("ScenarioController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + toolMocks: [{ toolName: "toolName", result: "result", enabled: true }], + path: "path", + }; + + server + .mockEndpoint() + .get("/eval/simulation/scenario/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationScenarios.scenarioControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + toolMocks: [ + { + toolName: "toolName", + result: "result", + enabled: true, + }, + ], + path: "path", + }); + }); + + test("ScenarioController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + toolMocks: [{ toolName: "toolName", result: "result", enabled: true }], + path: "path", + }; + + server + .mockEndpoint() + .delete("/eval/simulation/scenario/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationScenarios.scenarioControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + toolMocks: [ + { + toolName: "toolName", + result: "result", + enabled: true, + }, + ], + path: "path", + }); + }); + + test("ScenarioController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [{ content: null, role: "assistant" }], + tools: [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { type: "enabled", budgetTokens: 1.1 }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [{ provider: "twilio", timeout: 60, record: false }], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { key: "value" }, + }, + credentials: [{ provider: "11labs", apiKey: "apiKey" }], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [{ type: "request-start", blocking: false }], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { key: "value" }, + { key: "value" }, + { key: "value" }, + { key: "value" }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { position: -1 }, + }, + ], + }, + }, + ], + variableValues: { key: "value" }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "。", + "，", + ".", + "!", + "?", + ";", + "،", + "۔", + "।", + "॥", + "|", + "||", + ",", + ":", + ], + formatPlan: { enabled: true, numberToDigitsCutoff: 2025 }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { key: "value" }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { enabled: true }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], + name: "name", + schema: { type: "string" }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { provider: "vapi" }, + customEndpointingRules: [{ type: "assistant", regex: "regex", timeoutSeconds: 1.1 }], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { key: "value" }, + backoffPlan: { + type: { key: "value" }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [{ key: "value" }, { key: "value" }, { key: "value" }, { key: "value" }], + }, + }, + keypadInputPlan: { enabled: true, timeoutSeconds: 1.1, delimiters: "#" }, + }, + toolMocks: [{ toolName: "toolName", result: "result", enabled: true }], + path: "path", + }; + + server + .mockEndpoint() + .patch("/eval/simulation/scenario/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationScenarios.scenarioControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Health Enrollment - Eligible Path", + instructions: "You are calling to enroll in the Twin Health program. Confirm your identity when asked.", + evaluations: [ + { + structuredOutputId: "structuredOutputId", + structuredOutput: { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + path: "contact.auth_started", + comparator: "=", + value: 1.1, + required: true, + }, + ], + hooks: [ + { + on: "simulation.run.started", + do: [ + { + type: "webhook", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + ], + }, + ], + targetOverrides: { + transcriber: { + provider: "assembly-ai", + language: "multi", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], + speechModel: "universal-streaming-english", + realtimeUrl: "realtimeUrl", + wordBoost: ["wordBoost"], + keytermsPrompt: ["keytermsPrompt"], + endUtteranceSilenceThreshold: 1.1, + disablePartialTranscripts: true, + fallbackPlan: { + transcribers: [ + { + provider: "assembly-ai", + confidenceThreshold: 0.4, + formatTurns: true, + endOfTurnConfidenceThreshold: 0.7, + minEndOfTurnSilenceWhenConfident: 160, + maxTurnSilence: 400, + vadAssistedEndpointingEnabled: true, + }, + ], + }, + }, + model: { + provider: "anthropic", + messages: [ + { + content: null, + role: "assistant", + }, + ], + tools: [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], + knowledgeBase: { + provider: "custom-knowledge-base", + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + }, + model: "claude-3-opus-20240229", + thinking: { + type: "enabled", + budgetTokens: 1.1, + }, + temperature: 1.1, + maxTokens: 1.1, + emotionRecognitionEnabled: true, + numFastTurns: 1.1, + }, + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + speed: 1.1, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + firstMessage: "Hello! How can I help you today?", + firstMessageInterruptionsEnabled: true, + firstMessageMode: "assistant-speaks-first", + voicemailDetection: "off", + clientMessages: [ + "conversation-update", + "function-call", + "hang", + "model-output", + "speech-update", + "status-update", + "transfer-update", + "transcript", + "tool-calls", + "user-interrupted", + "voice-input", + "workflow.node.started", + "assistant.started", + ], + serverMessages: [ + "conversation-update", + "end-of-call-report", + "function-call", + "hang", + "speech-update", + "status-update", + "tool-calls", + "transfer-destination-request", + "handoff-destination-request", + "user-interrupted", + "assistant.started", + ], + maxDurationSeconds: 600, + backgroundSound: "https://www.soundjay.com/ambient/sounds/people-in-lounge-1.mp3", + modelOutputInMessagesEnabled: false, + transportConfigurations: [ + { + provider: "twilio", + timeout: 60, + record: false, + }, + ], + observabilityPlan: { + provider: "langfuse", + promptName: "promptName", + promptVersion: 1.1, + traceName: "traceName", + tags: ["tags"], + metadata: { + key: "value", + }, + }, + credentials: [ + { + provider: "11labs", + apiKey: "apiKey", + }, + ], + hooks: [ + { + on: "call.ending", + do: [ + { + type: "tool", + tool: { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + }, + ], + }, + ], + "tools:append": [ + { + type: "apiRequest", + messages: [ + { + type: "request-start", + blocking: false, + }, + ], + method: "POST", + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + url: "url", + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + rejectionPlan: { + conditions: [ + { + type: "regex", + regex: "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", + target: { + position: -1, + }, + }, + ], + }, + }, + ], + variableValues: { + key: "value", + }, + name: "name", + voicemailMessage: "voicemailMessage", + endCallMessage: "endCallMessage", + endCallPhrases: ["endCallPhrases"], + compliancePlan: { + hipaaEnabled: true, + pciEnabled: true, + recordingConsentPlan: { + type: "stay-on-line", + message: + "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.", + voice: { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + fallbackPlan: { + voices: [ + { + provider: "azure", + cachingEnabled: true, + voiceId: "andrew", + chunkPlan: { + enabled: true, + minCharacters: 30, + punctuationBoundaries: [ + "\u3002", + "\uFF0C", + ".", + "!", + "?", + ";", + "\u060C", + "\u06D4", + "\u0964", + "\u0965", + "|", + "||", + ",", + ":", + ], + formatPlan: { + enabled: true, + numberToDigitsCutoff: 2025, + }, + }, + }, + ], + }, + }, + waitSeconds: 3, + }, + }, + metadata: { + key: "value", + }, + backgroundSpeechDenoisingPlan: { + fourierDenoisingPlan: { + mediaDetectionEnabled: true, + staticThreshold: -35, + baselineOffsetDb: -15, + windowSizeMs: 3000, + baselinePercentile: 85, + }, + }, + artifactPlan: { + recordingEnabled: true, + recordingFormat: "wav;l16", + recordingUseCustomStorageEnabled: true, + videoRecordingEnabled: false, + fullMessageHistoryEnabled: false, + pcapEnabled: true, + pcapS3PathPrefix: "/pcaps", + pcapUseCustomStorageEnabled: true, + loggingEnabled: true, + loggingUseCustomStorageEnabled: true, + transcriptPlan: { + enabled: true, + }, + recordingPath: "recordingPath", + structuredOutputIds: ["structuredOutputIds"], + structuredOutputs: [ + { + compliancePlan: { + forceStoreOnHipaaEnabled: false, + }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], + name: "name", + schema: { + type: "string", + }, + }, + ], + scorecardIds: ["scorecardIds"], + scorecards: [ + { + metrics: [ + { + conditions: [ + { + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, + }, + ], + structuredOutputId: "structuredOutputId", + }, + ], + }, + ], + loggingPath: "loggingPath", + }, + startSpeakingPlan: { + waitSeconds: 0.4, + smartEndpointingPlan: { + provider: "vapi", + }, + customEndpointingRules: [ + { + type: "assistant", + regex: "regex", + timeoutSeconds: 1.1, + }, + ], + transcriptionEndpointingPlan: { + onPunctuationSeconds: 0.1, + onNoPunctuationSeconds: 1.5, + onNumberSeconds: 0.5, + }, + }, + stopSpeakingPlan: { + numWords: 0, + voiceSeconds: 0.2, + backoffSeconds: 1, + acknowledgementPhrases: [ + "i understand", + "i see", + "i got it", + "i hear you", + "im listening", + "im with you", + "right", + "okay", + "ok", + "sure", + "alright", + "got it", + "understood", + "yeah", + "yes", + "uh-huh", + "mm-hmm", + "gotcha", + "mhmm", + "ah", + "yeah okay", + "yeah sure", + ], + interruptionPhrases: [ + "stop", + "shut", + "up", + "enough", + "quiet", + "silence", + "but", + "dont", + "not", + "no", + "hold", + "wait", + "cut", + "pause", + "nope", + "nah", + "nevermind", + "never", + "bad", + "actually", + ], + }, + monitorPlan: { + listenEnabled: false, + listenAuthenticationEnabled: false, + controlEnabled: false, + controlAuthenticationEnabled: false, + monitorIds: ["123e4567-e89b-12d3-a456-426614174000"], + }, + credentialIds: ["credentialIds"], + server: { + timeoutSeconds: 20, + credentialId: "550e8400-e29b-41d4-a716-446655440000", + staticIpAddressesEnabled: false, + encryptedPaths: ["encryptedPaths"], + url: "url", + headers: { + key: "value", + }, + backoffPlan: { + type: { + key: "value", + }, + maxRetries: 0, + baseDelaySeconds: 1, + excludedStatusCodes: [ + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + { + key: "value", + }, + ], + }, + }, + keypadInputPlan: { + enabled: true, + timeoutSeconds: 1.1, + delimiters: "#", + }, + }, + toolMocks: [ + { + toolName: "toolName", + result: "result", + enabled: true, + }, + ], + path: "path", + }); + }); +}); diff --git a/tests/wire/simulationSuites.test.ts b/tests/wire/simulationSuites.test.ts new file mode 100644 index 00000000..291ea1d4 --- /dev/null +++ b/tests/wire/simulationSuites.test.ts @@ -0,0 +1,236 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("SimulationSuitesClient", () => { + test("SimulationSuiteController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [{ targetType: "assistant", targetId: "targetId" }], + }, + ]; + + server + .mockEndpoint() + .get("/eval/simulation/suite") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationSuites.simulationSuiteControllerFindAll(); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [ + { + targetType: "assistant", + targetId: "targetId", + }, + ], + }, + ]); + }); + + test("SimulationSuiteController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { name: "Checkout Flow Tests", simulationIds: ["simulationIds"] }; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [{ targetType: "assistant", targetId: "targetId" }], + }; + + server + .mockEndpoint() + .post("/eval/simulation/suite") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationSuites.simulationSuiteControllerCreate({ + name: "Checkout Flow Tests", + simulationIds: ["simulationIds"], + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [ + { + targetType: "assistant", + targetId: "targetId", + }, + ], + }); + }); + + test("SimulationSuiteController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [{ targetType: "assistant", targetId: "targetId" }], + }; + + server + .mockEndpoint() + .get("/eval/simulation/suite/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationSuites.simulationSuiteControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [ + { + targetType: "assistant", + targetId: "targetId", + }, + ], + }); + }); + + test("SimulationSuiteController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [{ targetType: "assistant", targetId: "targetId" }], + }; + + server + .mockEndpoint() + .delete("/eval/simulation/suite/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationSuites.simulationSuiteControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [ + { + targetType: "assistant", + targetId: "targetId", + }, + ], + }); + }); + + test("SimulationSuiteController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [{ targetType: "assistant", targetId: "targetId" }], + }; + + server + .mockEndpoint() + .patch("/eval/simulation/suite/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulationSuites.simulationSuiteControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Checkout Flow Tests", + slackWebhookUrl: "slackWebhookUrl", + path: "path", + simulationIds: ["simulationIds"], + targetAssignments: [ + { + targetType: "assistant", + targetId: "targetId", + }, + ], + }); + }); +}); diff --git a/tests/wire/simulations.test.ts b/tests/wire/simulations.test.ts new file mode 100644 index 00000000..b768cab9 --- /dev/null +++ b/tests/wire/simulations.test.ts @@ -0,0 +1,261 @@ +// This file was auto-generated by Fern from our API Definition. + +import { VapiClient } from "../../src/Client"; +import { mockServerPool } from "../mock-server/MockServerPool"; + +describe("SimulationsClient", () => { + test("SimulationGenerateController_generate", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + scenarios: [{ name: "name", instructions: "instructions", category: "happy_path", reasoning: "reasoning" }], + coverageNotes: "coverageNotes", + }; + + server + .mockEndpoint() + .post("/eval/simulation/scenario/generate") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationGenerateControllerGenerate(); + expect(response).toEqual({ + scenarios: [ + { + name: "name", + instructions: "instructions", + category: "happy_path", + reasoning: "reasoning", + }, + ], + coverageNotes: "coverageNotes", + }); + }); + + test("SimulationController_findAll", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = [ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }, + ]; + + server.mockEndpoint().get("/eval/simulation").respondWith().statusCode(200).jsonBody(rawResponseBody).build(); + + const response = await client.simulations.simulationControllerFindAll(); + expect(response).toEqual([ + { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }, + ]); + }); + + test("SimulationController_create", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = { scenarioId: "scenarioId", personalityId: "personalityId" }; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }; + + server + .mockEndpoint() + .post("/eval/simulation") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationControllerCreate({ + scenarioId: "scenarioId", + personalityId: "personalityId", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }); + }); + + test("SimulationController_findOne", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }; + + server + .mockEndpoint() + .get("/eval/simulation/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationControllerFindOne({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }); + }); + + test("SimulationController_remove", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }; + + server + .mockEndpoint() + .delete("/eval/simulation/id") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationControllerRemove({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }); + }); + + test("SimulationController_update", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + const rawRequestBody = {}; + const rawResponseBody = { + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }; + + server + .mockEndpoint() + .patch("/eval/simulation/id") + .jsonBody(rawRequestBody) + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationControllerUpdate({ + id: "id", + }); + expect(response).toEqual({ + id: "id", + orgId: "orgId", + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + name: "Eligible Path with Confused User", + scenarioId: "scenarioId", + personalityId: "personalityId", + path: "path", + }); + }); + + test("SimulationController_getConcurrency", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { + orgId: "orgId", + concurrencyLimit: 1.1, + activeSimulations: 1.1, + availableToStart: 1.1, + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + isDefault: true, + }; + + server + .mockEndpoint() + .get("/eval/simulation/concurrency") + .respondWith() + .statusCode(200) + .jsonBody(rawResponseBody) + .build(); + + const response = await client.simulations.simulationControllerGetConcurrency(); + expect(response).toEqual({ + orgId: "orgId", + concurrencyLimit: 1.1, + activeSimulations: 1.1, + availableToStart: 1.1, + createdAt: "2024-01-15T09:30:00Z", + updatedAt: "2024-01-15T09:30:00Z", + isDefault: true, + }); + }); +}); diff --git a/tests/wire/squads.test.ts b/tests/wire/squads.test.ts index f1dcc820..13f5a68a 100644 --- a/tests/wire/squads.test.ts +++ b/tests/wire/squads.test.ts @@ -305,6 +305,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -715,6 +719,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1137,6 +1145,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -1610,6 +1622,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2122,6 +2144,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2653,6 +2685,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -2773,6 +2815,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], assistantId: "assistantId", assistant: { @@ -3066,6 +3109,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -3476,6 +3523,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -3577,6 +3628,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -3631,6 +3686,7 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -3925,13 +3981,24 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -4042,6 +4109,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [ { type: "assistant", @@ -4411,6 +4479,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -4923,6 +5001,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -5038,6 +5126,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -5114,6 +5206,12 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -5488,6 +5586,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -5499,12 +5607,15 @@ describe("SquadsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -5640,6 +5751,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], assistantId: "assistantId", assistant: { @@ -5933,6 +6045,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -6343,6 +6459,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -6444,6 +6564,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -6498,6 +6622,7 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -6792,13 +6917,24 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -6902,6 +7038,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [ { type: "assistant", @@ -7271,6 +7408,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -7783,6 +7930,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -7898,6 +8055,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -7974,6 +8135,12 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -8348,6 +8515,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -8359,12 +8536,15 @@ describe("SquadsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -8500,6 +8680,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], assistantId: "assistantId", assistant: { @@ -8793,6 +8974,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -9203,6 +9388,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -9304,6 +9493,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -9358,6 +9551,7 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -9652,13 +9846,24 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -9762,6 +9967,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [ { type: "assistant", @@ -10131,6 +10337,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -10643,6 +10859,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -10758,6 +10984,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -10834,6 +11064,12 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -11208,6 +11444,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -11219,12 +11465,15 @@ describe("SquadsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, @@ -11360,6 +11609,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [{ type: "assistant", assistantName: "assistantName" }], assistantId: "assistantId", assistant: { @@ -11653,6 +11903,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -12063,6 +12317,10 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, @@ -12164,6 +12422,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -12218,6 +12480,7 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [{ toolId: "toolId", version: "version" }], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -12512,13 +12775,24 @@ describe("SquadsClient", () => { structuredOutputs: [ { compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], name: "name", schema: { type: "string" }, }, ], scorecardIds: ["scorecardIds"], scorecards: [ - { metrics: [{ structuredOutputId: "structuredOutputId", conditions: [{ key: "value" }] }] }, + { + metrics: [ + { + conditions: [{ type: "comparator", comparator: "=", value: 1.1, points: 1.1 }], + structuredOutputId: "structuredOutputId", + }, + ], + }, ], loggingPath: "loggingPath", }, @@ -12630,6 +12904,7 @@ describe("SquadsClient", () => { name: "name", members: [ { + assistantVersion: "assistantVersion", assistantDestinations: [ { type: "assistant", @@ -12999,6 +13274,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -13511,6 +13796,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -13626,6 +13921,10 @@ describe("SquadsClient", () => { minEndOfTurnSilenceWhenConfident: 160, maxTurnSilence: 400, vadAssistedEndpointingEnabled: true, + mode: "max_accuracy", + prompt: "prompt", + agentContext: "agentContext", + languageCodes: ["en"], speechModel: "universal-streaming-english", realtimeUrl: "realtimeUrl", wordBoost: ["wordBoost"], @@ -13702,6 +14001,12 @@ describe("SquadsClient", () => { }, ], toolIds: ["toolIds"], + toolRefs: [ + { + toolId: "toolId", + version: "version", + }, + ], knowledgeBase: { provider: "custom-knowledge-base", server: { @@ -14076,6 +14381,16 @@ describe("SquadsClient", () => { compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], name: "name", schema: { type: "string", @@ -14087,12 +14402,15 @@ describe("SquadsClient", () => { { metrics: [ { - structuredOutputId: "structuredOutputId", conditions: [ { - key: "value", + type: "comparator", + comparator: "=", + value: 1.1, + points: 1.1, }, ], + structuredOutputId: "structuredOutputId", }, ], }, diff --git a/tests/wire/structuredOutputs.test.ts b/tests/wire/structuredOutputs.test.ts index 6b61305e..c9708e03 100644 --- a/tests/wire/structuredOutputs.test.ts +++ b/tests/wire/structuredOutputs.test.ts @@ -13,8 +13,12 @@ describe("StructuredOutputsClient", () => { { type: "ai", regex: "regex", - model: { provider: "openai", model: "gpt-5.4" }, + model: { provider: "openai", model: "gpt-5.6-sol" }, compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -30,6 +34,10 @@ describe("StructuredOutputsClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -46,11 +54,21 @@ describe("StructuredOutputsClient", () => { regex: "regex", model: { provider: "openai", - model: "gpt-5.4", + model: "gpt-5.6-sol", }, compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -68,6 +86,10 @@ describe("StructuredOutputsClient", () => { itemsPerPage: 1.1, totalItems: 1.1, currentPage: 1.1, + totalPages: 1.1, + hasNextPage: true, + nextCursor: "nextCursor", + sortOrder: "ASC", itemsBeyondRetention: true, createdAtLe: "2024-01-15T09:30:00Z", createdAtGe: "2024-01-15T09:30:00Z", @@ -82,8 +104,18 @@ describe("StructuredOutputsClient", () => { const rawResponseBody = { type: "ai", regex: "regex", - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, + model: { + provider: "openai", + messages: [{ content: null, role: "assistant" }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1, + }, compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -123,13 +155,29 @@ describe("StructuredOutputsClient", () => { regex: "regex", model: { provider: "openai", - model: "gpt-5.4", + messages: [ + { + content: null, + role: "assistant", + }, + ], + model: "gpt-5.6-sol", temperature: 1.1, maxTokens: 1.1, }, compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -157,8 +205,18 @@ describe("StructuredOutputsClient", () => { const rawResponseBody = { type: "ai", regex: "regex", - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, + model: { + provider: "openai", + messages: [{ content: null, role: "assistant" }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1, + }, compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -194,13 +252,29 @@ describe("StructuredOutputsClient", () => { regex: "regex", model: { provider: "openai", - model: "gpt-5.4", + messages: [ + { + content: null, + role: "assistant", + }, + ], + model: "gpt-5.6-sol", temperature: 1.1, maxTokens: 1.1, }, compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -228,8 +302,18 @@ describe("StructuredOutputsClient", () => { const rawResponseBody = { type: "ai", regex: "regex", - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, + model: { + provider: "openai", + messages: [{ content: null, role: "assistant" }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1, + }, compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -265,13 +349,29 @@ describe("StructuredOutputsClient", () => { regex: "regex", model: { provider: "openai", - model: "gpt-5.4", + messages: [ + { + content: null, + role: "assistant", + }, + ], + model: "gpt-5.6-sol", temperature: 1.1, maxTokens: 1.1, }, compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -299,8 +399,18 @@ describe("StructuredOutputsClient", () => { const rawResponseBody = { type: "ai", regex: "regex", - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, + model: { + provider: "openai", + messages: [{ content: null, role: "assistant" }], + model: "gpt-5.6-sol", + temperature: 1.1, + maxTokens: 1.1, + }, compliancePlan: { forceStoreOnHipaaEnabled: false }, + conditions: [ + { type: "minMessages", count: 4 }, + { type: "minCallDuration", seconds: 10 }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -338,13 +448,29 @@ describe("StructuredOutputsClient", () => { regex: "regex", model: { provider: "openai", - model: "gpt-5.4", + messages: [ + { + content: null, + role: "assistant", + }, + ], + model: "gpt-5.6-sol", temperature: 1.1, maxTokens: 1.1, }, compliancePlan: { forceStoreOnHipaaEnabled: false, }, + conditions: [ + { + type: "minMessages", + count: 4, + }, + { + type: "minCallDuration", + seconds: 10, + }, + ], id: "id", orgId: "orgId", createdAt: "2024-01-15T09:30:00Z", @@ -370,27 +496,7 @@ describe("StructuredOutputsClient", () => { const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); const rawRequestBody = { callIds: ["callIds"] }; const rawResponseBody = { - type: "ai", - regex: "regex", - model: { provider: "openai", model: "gpt-5.4", temperature: 1.1, maxTokens: 1.1 }, - compliancePlan: { forceStoreOnHipaaEnabled: false }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - name: "name", - description: "description", - assistantIds: ["assistantIds"], - workflowIds: ["workflowIds"], - schema: { - type: "string", - description: "description", - pattern: "pattern", - format: "date-time", - required: ["required"], - enum: ["enum"], - title: "title", - }, + skipped: { key: { name: "name", unmetCondition: { type: "minMessages", count: 4 } } }, }; server @@ -406,33 +512,14 @@ describe("StructuredOutputsClient", () => { callIds: ["callIds"], }); expect(response).toEqual({ - type: "ai", - regex: "regex", - model: { - provider: "openai", - model: "gpt-5.4", - temperature: 1.1, - maxTokens: 1.1, - }, - compliancePlan: { - forceStoreOnHipaaEnabled: false, - }, - id: "id", - orgId: "orgId", - createdAt: "2024-01-15T09:30:00Z", - updatedAt: "2024-01-15T09:30:00Z", - name: "name", - description: "description", - assistantIds: ["assistantIds"], - workflowIds: ["workflowIds"], - schema: { - type: "string", - description: "description", - pattern: "pattern", - format: "date-time", - required: ["required"], - enum: ["enum"], - title: "title", + skipped: { + key: { + name: "name", + unmetCondition: { + type: "minMessages", + count: 4, + }, + }, }, }); }); diff --git a/tests/wire/tools.test.ts b/tests/wire/tools.test.ts index 51812adc..21413eeb 100644 --- a/tests/wire/tools.test.ts +++ b/tests/wire/tools.test.ts @@ -1,5 +1,6 @@ // This file was auto-generated by Fern from our API Definition. +import * as Vapi from "../../src/api/index"; import { VapiClient } from "../../src/Client"; import { mockServerPool } from "../mock-server/MockServerPool"; @@ -11,7 +12,9 @@ describe("ToolsClient", () => { const rawResponseBody = [ { type: "apiRequest", + latestVersion: "latestVersion", messages: [{ type: "request-start", blocking: false }], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -30,7 +33,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -67,12 +69,14 @@ describe("ToolsClient", () => { expect(response).toEqual([ { type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", blocking: false, }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -98,7 +102,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -161,6 +164,7 @@ describe("ToolsClient", () => { const rawRequestBody = { type: "apiRequest", method: "POST", url: "url" }; const rawResponseBody = { type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -170,6 +174,7 @@ describe("ToolsClient", () => { conditions: [{ operator: "eq", param: "param", value: "value" }], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -188,7 +193,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -245,6 +249,7 @@ describe("ToolsClient", () => { }); expect(response).toEqual({ type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -266,6 +271,7 @@ describe("ToolsClient", () => { ], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -291,7 +297,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -359,6 +364,7 @@ describe("ToolsClient", () => { const rawResponseBody = { type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -368,6 +374,7 @@ describe("ToolsClient", () => { conditions: [{ operator: "eq", param: "param", value: "value" }], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -386,7 +393,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -434,6 +440,7 @@ describe("ToolsClient", () => { }); expect(response).toEqual({ type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -455,6 +462,7 @@ describe("ToolsClient", () => { ], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -480,7 +488,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -542,12 +549,13 @@ describe("ToolsClient", () => { }); }); - test("delete", async () => { + test("delete (1)", async () => { const server = mockServerPool.createServer(); const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); const rawResponseBody = { type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -557,6 +565,7 @@ describe("ToolsClient", () => { conditions: [{ operator: "eq", param: "param", value: "value" }], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -575,7 +584,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -623,6 +631,7 @@ describe("ToolsClient", () => { }); expect(response).toEqual({ type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -644,6 +653,7 @@ describe("ToolsClient", () => { ], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -669,7 +679,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -731,12 +740,28 @@ describe("ToolsClient", () => { }); }); + test("delete (2)", async () => { + const server = mockServerPool.createServer(); + const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); + + const rawResponseBody = { key: "value" }; + + server.mockEndpoint().delete("/tool/id").respondWith().statusCode(409).jsonBody(rawResponseBody).build(); + + await expect(async () => { + return await client.tools.delete({ + id: "id", + }); + }).rejects.toThrow(Vapi.ConflictError); + }); + test("update", async () => { const server = mockServerPool.createServer(); const client = new VapiClient({ maxRetries: 0, token: "test", environment: server.baseUrl }); const rawRequestBody = { type: "apiRequest" }; const rawResponseBody = { type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -746,6 +771,7 @@ describe("ToolsClient", () => { conditions: [{ operator: "eq", param: "param", value: "value" }], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -764,7 +790,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { @@ -822,6 +847,7 @@ describe("ToolsClient", () => { }); expect(response).toEqual({ type: "apiRequest", + latestVersion: "latestVersion", messages: [ { type: "request-start", @@ -843,6 +869,7 @@ describe("ToolsClient", () => { ], }, ], + name: "name", method: "POST", timeoutSeconds: 20, credentialId: "550e8400-e29b-41d4-a716-446655440000", @@ -868,7 +895,6 @@ describe("ToolsClient", () => { }, ], }, - name: "name", description: "description", url: "url", body: { From 4deae2ab900b0cca1a684628653e9ba41e9bd1d2 Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 19 Aug 2026 00:24:04 +0000 Subject: [PATCH 2/4] [fern-autoversion] SDK regeneration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🌿 Generated with Fern --- .fern/metadata.json | 2 +- package.json | 2 +- src/BaseClient.ts | 4 ++-- src/version.ts | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.fern/metadata.json b/.fern/metadata.json index 8681b9f9..6c873739 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -16,5 +16,5 @@ "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "0.0.0-fern-placeholder" + "sdkVersion": "2.0.1" } diff --git a/package.json b/package.json index fa9425b9..5ebe74c5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vapi-ai/server-sdk", - "version": "0.0.0-fern-placeholder", + "version": "2.0.1", "private": false, "repository": { "type": "git", diff --git a/src/BaseClient.ts b/src/BaseClient.ts index 0cbc606c..57a9cccf 100644 --- a/src/BaseClient.ts +++ b/src/BaseClient.ts @@ -52,8 +52,8 @@ export function normalizeClientOptions Date: Wed, 19 Aug 2026 00:24:05 +0000 Subject: [PATCH 3/4] [fern-replay] advance lockfile --- .fern/replay.lock | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.fern/replay.lock b/.fern/replay.lock index 9c98e86e..f56764a4 100644 --- a/.fern/replay.lock +++ b/.fern/replay.lock @@ -6,5 +6,11 @@ generations: timestamp: 2026-08-19T00:22:56.996Z cli_version: unknown generator_versions: {} -current_generation: a1c6092cc00dca56259110e7ad5d14b616d25ed5 + - commit_sha: 3fe25a5a1fdd2dcbda63167d5ffad7ffd17c507d + tree_hash: 91f43227b9b8e229e90dd63242013e6b132c1b8f + timestamp: 2026-08-19T00:22:58.285Z + cli_version: unknown + generator_versions: + fernapi/fern-typescript-sdk: 3.63.0 +current_generation: 3fe25a5a1fdd2dcbda63167d5ffad7ffd17c507d patches: [] From b87253e4d9d2e4534e8415e902c9ade5be04b30b Mon Sep 17 00:00:00 2001 From: "fern-api[bot]" <115122769+fern-api[bot]@users.noreply.github.com> Date: Wed, 19 Aug 2026 00:24:05 +0000 Subject: [PATCH 4/4] SDK regeneration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🌿 Generated with Fern --- changelog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/changelog.md b/changelog.md index 1813cfb9..370ad647 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,5 @@ +## [2.0.1] - 2026-08-19 + ## 2.0.0 - 2026-06-24 ### Breaking Changes * **`CartesiaExperimentalControlsSpeedZero`** has been removed and replaced by **`CartesiaSpeedControlZero`**, which carries the same `"slowest" | "slow" | "normal" | "fast" | "fastest"` values. Update any imports or references from `CartesiaExperimentalControlsSpeedZero` to `CartesiaSpeedControlZero`.