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.
Parameters
The only required parameter is prompt
. But the others are quite powerful, so we recommend trying them out!
Name | Type | Description |
---|---|---|
agent_meta_data | object | A powerful and flexible environmental variable which can accept arbitrary data. All contained information can be accessed and expanded within the prompt - for example, by using a template string. |
hints | string | An array of hints (as strings) to provide context to the dialogue. |
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_auth_password | string | Auth password for post_url endpoint. |
post_prompt_auth_user | string | Auth username for post_url endpoint. |
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. |
pronounce | object | An array of JSON objects to clarify the AI's pronunciation of words or expressions. |
prompt | object | Establishes the initial set of instructions and settings to configure the agent. This is a required parameter. |
SWAIG | object | An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. |