vapi4k-core/com.vapi4k.dtos.tools/ToolMessageCompleteDto

ToolMessageCompleteDto

@Serializable

class ToolMessageCompleteDto(var content: String = "", val conditions: MutableSet<ToolMessageCondition> = mutableSetOf(), var role: ToolMessageRoleType = ToolMessageRoleType.UNSPECIFIED, var endCallAfterSpokenEnabled: Boolean? = null) : AbstractToolMessageDto, ToolMessageCompleteProperties, CommonToolMessageDto(source)

Constructors

constructor(content: String = "", conditions: MutableSet<ToolMessageCondition> = mutableSetOf(), role: ToolMessageRoleType = ToolMessageRoleType.UNSPECIFIED, endCallAfterSpokenEnabled: Boolean? = null)

Properties

conditions

open override val conditions: MutableSet<ToolMessageCondition>

content

open override var content: String

This is the content that the assistant says when this message is triggered.

endCallAfterSpokenEnabled

open override var endCallAfterSpokenEnabled: Boolean?

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.

role

open override var role: ToolMessageRoleType

This is optional and defaults to "assistant".
When role=assistant, content is said out loud.
When role=system, content is passed to the model in a system message. Example: system: default one assistant: user: assistant: user: assistant: user: assistant: tool called tool: your server response <--- system prompt as hint ---> model generates response which is spoken This is useful when you want to provide a hint to the model about what to say next.

type

@EncodeDefault

val type: ToolMessageType

Functions

verifyValues

fun verifyValues()