ai

Create an AI agent with a prompt. Since the text prompt is central to getting great results out of the AI, it is highly recommended that you also read the Prompting Best Practices guide.

ai

objectrequired

An object that contains the ai parameters.

ai Parameters

prompt

objectrequired

Establishes the initial set of instructions and settings to configure the agent.

global_data

object

A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML set_global_data action. This data can be referenced globally. All contained information can be accessed and expanded within the prompt - for example, by using a template string.

hints

string

Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately.

languages

object

An array of JSON objects defining supported languages in the conversation.

params

object

A JSON object containing parameters as key-value pairs.

post_prompt

object

The final set of instructions and configuration settings to send to the agent.

post_prompt_url

string

The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of username:password@url.

pronounce

object

An array of JSON objects to clarify the AI's pronunciation of words or expressions.

SWAIG

object

An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.