vapi4k-core/com.vapi4k.dtos.api.destination/AssistantDestinationDto

AssistantDestinationDto

@Serializable
data class AssistantDestinationDto(var message: String = "", var description: String = "", var assistantName: String = "", var transferMode: AssistantTransferMode = AssistantTransferMode.UNSPECIFIED) : CommonDestinationDto, AssistantDestination(source)

Constructors

Link copied to clipboard
constructor(message: String = "", description: String = "", assistantName: String = "", transferMode: AssistantTransferMode = AssistantTransferMode.UNSPECIFIED)

Properties

Link copied to clipboard
open override var assistantName: String

This is the assistant to transfer the call to.

Link copied to clipboard
open override var description: String

This is the description of the destination, used by the AI to choose when and how to transfer the call.

Link copied to clipboard
open override var message: String

This is the message to say before transferring the call to the destination.
If this is not provided and transfer tool messages is not provided, default is "Transferring the call now".
If set to "", nothing is spoken. This is useful when you want to silently transfer. This is especially useful when transferring between assistants in a squad. In this scenario, you likely also want to set assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message for the destination assistant.

Link copied to clipboard
open override var transferMode: AssistantTransferMode

This is the mode to use for the transfer. Default is rolling-history.

  • rolling-history: This is the default mode. It keeps the entire conversation history and appends the new assistant's system message on transfer. Example: Pre-transfer: system: assistant1 system message assistant: assistant1 first message user: hey, good morning assistant: how can I help? user: I need help with my account assistant: (destination.message) Post-transfer: system: assistant1 system message assistant: assistant1 first message user: hey, good morning assistant: how can I help? user: I need help with my account assistant: (destination.message) system: assistant2 system message assistant: assistant2 first message (or model generated if firstMessageMode is set to assistant-speaks-first-with-model-generated-message)
  • swap-system-message-in-history: This replaces the original system message with the new assistant's system message on transfer. Example: Pre-transfer: system: assistant1 system message assistant: assistant1 first message user: hey, good morning assistant: how can I help? user: I need help with my account assistant: (destination.message) Post-transfer: system: assistant2 system message assistant: assistant1 first message user: hey, good morning assistant: how can I help? user: I need help with my account assistant: (destination.message) assistant: assistant2 first message (or model generated if firstMessageMode is set to assistant-speaks-first-with-model-generated-message)

Link copied to clipboard
@EncodeDefault
val type: DestinationType