QueuedConversation\<TInput, TOutput>
A conversation between an Application and its conversational partner.
Extends
EventEmitter<{debugLog: [unknown];transcription: [Transcription]; }>
Type Parameters
• TInput extends Record<string, unknown>
• TOutput extends Record<string, unknown>
Implements
Conversation<TInput,TOutput>
Properties
audio
audio:
AudioConfig
Implementation of
input
input:
TInput
The input data to be passed as the input context of a DashaScript application.
Implementation of
log
readonlylog:Logger
Implementation of
sip
sip:
SipConfig
Implementation of
Accessors
jobId
Get Signature
get jobId():
string
Returns
string
Implementation of
jobKey
Get Signature
get jobKey():
string
Returns
string
Implementation of
Methods
execute()
execute(
options?):Promise<ConversationResult<TOutput>>
Start a conversation, i.e. run the DashaScript code on a specified input.
Returns a promise that settles when the conversation has finished. It rejects on errors, and resolves on successful completion.
Parameters
options?
cancelToken
channel
"text" | "audio"
Returns
Promise<ConversationResult<TOutput>>
Implementation of
ignore()
ignore():
Promise<void>
Explicitly mark this conversation as not being executed, freeing up server-side resources
Returns
Promise<void>
sendEvent()
sendEvent(
eventName,eventValue):Promise<void>
Parameters
eventName
string
eventValue
Record<string, string>
Returns
Promise<void>
Implementation of
setDynamicTool()
setDynamicTool<
T>(options,handler?):Promise<void>
Type Parameters
• T extends TSchema
Parameters
options
DynamicToolScheme<T>
handler?
(args, conv) => unknown
Returns
Promise<void>
Implementation of
setDynamicToolRaw()
setDynamicToolRaw(
options,handler?):Promise<void>
Parameters
options
DynamicToolDescription
handler?
(args, conv) => unknown
Returns
Promise<void>