Application\<TInput, TOutput>

A DashaScript conversational application deployed to the Dasha platform.

• EventEmitter<{ error: [Error]; health: [boolean]; reconnecting: [number]; unableToReconnect: [Error]; }>

• TInput extends Record<string, unknown>

conversation input data type

• TOutput extends Record<string, unknown>

conversation output data type

A user Account that the application was deployed under.

An internal application UID.

Application name as seen in [.dashaapp]. [.dashaapp]: https://docs.dasha.ai/en-us/default/application/configuration/#application-name

An instance of the axios HTTP client used for #httpRequest(), or null if #httpRequest() has been disabled.

Initialized with the value of DeploymentOptions.axios

A ConnectionProvider to use for this application's conversations.

use the channel argument to Conversation.execute instead

An internal client UID.

A CustomTtsProvider callback to use when the TtsProviderName | TTS provider is set to "custom" in Conversation.audio.tts.

An internal application group UID.

JSON Schema of DSL context input variables. Conversation context: https://docs.dasha.ai/en-us/default/dasha-script-language/conversation-context

JSON Schema of DSL context output variables. Conversation context: https://docs.dasha.ai/en-us/default/dasha-script-language/conversation-context

A ConversationQueue object for managing planned conversations.

An SttDispatcher callback that selects a speech-to-text engine for all new conversations. If not set explicitly, a "default" SttProviderName | STT provider will be used.

use Conversation.audio.stt instead

A TtsDispatcher callback that selects a text-to-speech engine for all new conversations. If not set explicitly, a "default" TtsProviderName | TTS provider will be used.

use Conversation.audio.tts instead

Create a single Conversation.

TInput

conversation's input data; can also be set later with Conversation.input

Conversation<TInput, TOutput>

Close the connection with the application, freeing all local resources.

void

Promise<boolean>

Set an external call handler for this application.

The handler is called with all the call arguments passed as a dictionary, as well as the current Conversation object. It can return a JSON-serializable value, possibly wrapped in a promise, which then is treated as the call's return value. As a special case, undefined gets converted to null.

• TArgs extends Record<string, unknown>

string

(args, conv) => unknown

void

Start the deployed application, enabling it to receive incoming requests and run queued conversations.

number

max number of conversations to run at once

Promise<void>

Stop the running application, disabling the creation of new conversations. Conversations that are already running are unaffected.

CancelToken

number

boolean

Promise<void>

CancelToken

number

Promise<boolean>