Skip to main content

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.

NameTypeDefaultDescription
aiRequiredobject-An object that contains the ai parameters.

ai Parameters

NameTypeDefaultDescription
global_meta_dataOptionalobject-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.
hintsOptionalstring-An array of hints (as strings) to provide context to the dialogue.
languagesOptionalobject-An array of JSON objects defining supported languages in the conversation.
paramsOptionalobject-A JSON object containing parameters as key-value pairs.
post_promptOptionalobject-The final set of instructions and configuration settings to send to the agent.
post_prompt_urlOptionalstring-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.
pronounceOptionalobject-An array of JSON objects to clarify the AI's pronunciation of words or expressions.
promptRequiredobject-Establishes the initial set of instructions and settings to configure the agent.
SWAIGOptionalobject-An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.