vapi4k-core/com.vapi4k.dtos.assistant

Package-level declarations

Types

Link copied to clipboard
@Serializable
abstract class AbstractAssistantDto(var backchannelingEnabled: Boolean? = null, var backgroundDenoisingEnabled: Boolean? = null, var backgroundSound: BackgroundSoundType = BackgroundSoundType.UNSPECIFIED, var endCallMessage: String = "", val endCallPhrases: MutableSet<String> = mutableSetOf(), var firstMessage: String = "", var firstMessageMode: FirstMessageModeType = FirstMessageModeType.UNSPECIFIED, var hipaaEnabled: Boolean? = null, var llmRequestDelaySeconds: Double = -1.0, var llmRequestNonPunctuatedDelaySeconds: Double = -1.0, var maxDurationSeconds: Int = -1, val metadata: MutableMap<String, String> = mutableMapOf(), var modelOutputInMessagesEnabled: Boolean? = null, var name: String = "", var numWordsToInterruptAssistant: Int = -1, var recordingEnabled: Boolean? = null, var responseDelaySeconds: Double = -1.0, var serverUrl: String = "", var serverUrlSecret: String = "", var silenceTimeoutSeconds: Int = -1, var voicemailMessage: String = "", var clientMessages: MutableSet<AssistantClientMessageType> = DEFAULT_CLIENT_MESSAGES.toMutableSet(), var serverMessages: MutableSet<AssistantServerMessageType> = DEFAULT_SERVER_MESSAGES.toMutableSet(), val transportConfigurations: MutableList<TransportConfigurationDto> = mutableListOf(), var forwardingPhoneNumber: String = "", var endCallFunctionEnabled: Boolean? = null, var dialKeypadFunctionEnabled: Boolean? = null)
Link copied to clipboard
@Serializable
data class AnalysisPlanDto(var summaryPrompt: String = "", var summaryRequestTimeoutSeconds: Double = -1.0, var structuredDataRequestTimeoutSeconds: Double = -1.0, var successEvaluationPrompt: String = "", var successEvaluationRubric: SuccessEvaluationRubricType = SuccessEvaluationRubricType.UNSPECIFIED, var successEvaluationRequestTimeoutSeconds: Double = -1.0, var structuredDataPrompt: String = "", val structuredDataSchema: StructuredDataSchemaDto = StructuredDataSchemaDto()) : AnalysisPlanProperties
Link copied to clipboard
@Serializable
data class ArtifactPlanDto(var videoRecordingEnabled: Boolean? = null) : ArtifactPlanProperties

This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.
Note: `recordingEnabled` is currently at the root level. It will be moved to `artifactPlan` in the future, but will remain backwards compatible.

Link copied to clipboard
@Serializable
data class AssistantDto(var backchannelingEnabled: Boolean? = null, var backgroundDenoisingEnabled: Boolean? = null, var backgroundSound: BackgroundSoundType = BackgroundSoundType.UNSPECIFIED, var endCallMessage: String = "", val endCallPhrases: MutableSet<String> = mutableSetOf(), var firstMessage: String = "", var firstMessageMode: FirstMessageModeType = FirstMessageModeType.UNSPECIFIED, var hipaaEnabled: Boolean? = null, var llmRequestDelaySeconds: Double = -1.0, var llmRequestNonPunctuatedDelaySeconds: Double = -1.0, var maxDurationSeconds: Int = -1, val metadata: MutableMap<String, String> = mutableMapOf(), var modelOutputInMessagesEnabled: Boolean? = null, var name: String = "", var numWordsToInterruptAssistant: Int = -1, var recordingEnabled: Boolean? = null, var responseDelaySeconds: Double = -1.0, var serverUrl: String = "", var serverUrlSecret: String = "", var silenceTimeoutSeconds: Int = -1, var voicemailMessage: String = "", var clientMessages: MutableSet<AssistantClientMessageType> = DEFAULT_CLIENT_MESSAGES.toMutableSet(), var serverMessages: MutableSet<AssistantServerMessageType> = DEFAULT_SERVER_MESSAGES.toMutableSet(), val transportConfigurations: MutableList<TransportConfigurationDto> = mutableListOf(), var forwardingPhoneNumber: String = "", var endCallFunctionEnabled: Boolean? = null, var dialKeypadFunctionEnabled: Boolean? = null, var transcriberDto: CommonTranscriberDto? = null, var modelDto: CommonModelDto? = null, var voiceDto: CommonVoiceDto? = null, val voicemailDetectionDto: VoicemailDetectionDto = VoicemailDetectionDto(), val analysisPlanDto: AnalysisPlanDto = AnalysisPlanDto(), val artifactPlanDto: ArtifactPlanDto = ArtifactPlanDto(), val messagePlanDto: MessagePlanDto = MessagePlanDto()) : AssistantProperties, ModelDtoUnion
Link copied to clipboard
@Serializable
data class AssistantOverridesDto(var backchannelingEnabled: Boolean? = null, var backgroundDenoisingEnabled: Boolean? = null, var backgroundSound: BackgroundSoundType = BackgroundSoundType.UNSPECIFIED, var endCallMessage: String = "", val endCallPhrases: MutableSet<String> = mutableSetOf(), var firstMessage: String = "", var firstMessageMode: FirstMessageModeType = FirstMessageModeType.UNSPECIFIED, var hipaaEnabled: Boolean? = null, var llmRequestDelaySeconds: Double = -1.0, var llmRequestNonPunctuatedDelaySeconds: Double = -1.0, var maxDurationSeconds: Int = -1, val metadata: MutableMap<String, String> = mutableMapOf(), var modelOutputInMessagesEnabled: Boolean? = null, var name: String = "", var numWordsToInterruptAssistant: Int = -1, var recordingEnabled: Boolean? = null, var responseDelaySeconds: Double = -1.0, var serverUrl: String = "", var serverUrlSecret: String = "", var silenceTimeoutSeconds: Int = -1, var voicemailMessage: String = "", var clientMessages: MutableSet<AssistantClientMessageType> = DEFAULT_CLIENT_MESSAGES.toMutableSet(), var serverMessages: MutableSet<AssistantServerMessageType> = DEFAULT_SERVER_MESSAGES.toMutableSet(), val transportConfigurations: MutableList<TransportConfigurationDto> = mutableListOf(), var forwardingPhoneNumber: String = "", var endCallFunctionEnabled: Boolean? = null, var dialKeypadFunctionEnabled: Boolean? = null, val variableValues: MutableMap<String, String> = mutableMapOf(), var transcriberDto: CommonTranscriberDto? = null, var modelDto: CommonModelDto? = null, var voiceDto: CommonVoiceDto? = null, val voicemailDetectionDto: VoicemailDetectionDto = VoicemailDetectionDto(), val analysisPlanDto: AnalysisPlanDto = AnalysisPlanDto(), val artifactPlanDto: ArtifactPlanDto = ArtifactPlanDto(), val messagePlanDto: MessagePlanDto = MessagePlanDto()) : AssistantOverridesProperties, ModelDtoUnion
Link copied to clipboard
@Serializable
data class MessagePlanDto(var idleMessageMaxSpokenCount: Double = -1.0, var idleTimeoutSeconds: Double = -1.0, val idleMessages: MutableList<String> = mutableListOf())
Link copied to clipboard
@Serializable
data class StructuredDataSchemaDto(var type: StructureDataSchemeType = StructureDataSchemeType.UNSPECIFIED, var description: String = "", val items: MutableMap<String, String> = mutableMapOf(), val properties: MutableMap<String, String> = mutableMapOf(), val required: MutableList<String> = mutableListOf()) : StructuredDataSchemaProperties
Link copied to clipboard
@Serializable
data class TransportConfigurationDto(var provider: String = "", var timeout: Int = -1, var record: Boolean? = null, var recordingChannels: String = "")
Link copied to clipboard
@Serializable
data class VoicemailDetectionDto(var provider: String = "twilio", var enabled: Boolean? = null, var machineDetectionTimeout: Int = -1, var machineDetectionSpeechThreshold: Int = -1, var machineDetectionSpeechEndThreshold: Int = -1, var machineDetectionSilenceTimeout: Int = -1, val voicemailDetectionTypes: MutableSet<VoicemailDetectionType> = mutableSetOf()) : VoicemailDetectionProperties