Ready-to-use tools for common functionality in voice applications.
Tool Name | Description |
---|---|
queryCorpus | Retrieves relevant information from an existing corpus (knowledge base). See Query Corpus API for details. |
leaveVoicemail | Leaves a voicemail and ends the call. Intended to be used with outbound phone calls. |
hangUp | Terminates the call programmatically. Useful for ending conversations gracefully. |
playDtmfSounds | Plays dual-tone multi-frequency (dialpad) tones. See DTMF documentation for sending and receiving tones. |
toolId
instead. Agents will see the modelToolName
.
queryCorpus
corpus_id
) to be used for all queries and a dynamic query
parameter is used for each query. Optionally, you can restrict the number of results that are returned to the agent (via max_results
) along with a minimum semantic similarity score (minimum_score
).
Example Usage:
leaveVoicemail
message
parameter is used for the message that will be left. Optionally, you can change the hang up behavior with strict
and the return message with result
.
Example Usage:
true
ends the call regardless of user interaction. If set to false
, any user interaction (i.e. speech or interrupting the voicemail) will cause the call to continue.hangUp
reason
. A static parameter called strict
can be overridden to enable the call to continue if the user speaks and continues the call.
Example Usage:
true
ends the call regardless of user interaction. If set to false
, any user interaction (i.e. speech) will cause the call to continue.playDtmfSounds
digits
. Static parameters for toneDuration
and spaceDuration
can be overridden. Automatically sets the sample rate based on current call medium.
Example:
toolId
, you’ll always get that specific tool. If you reference by toolName
and have a custom tool with the same name, your custom tool takes precedence over the built-in version.queryCorpus
require you to specify which corpus to search via parameter overrides.