ai.prompt
| Name | Type | Default | Description |
|---|---|---|---|
promptRequired | object | - | An object that accepts the prompt parameters. |
prompt Parameters
The prompt property accepts one of the following objects:
- Regular Prompt
- Context Prompts
- POM Prompts
| Name | Type | Default | Description |
|---|---|---|---|
textRequired | string | - | The main identity prompt for the AI. This prompt will be used to outline the agent's personality, role, and other characteristics. |
temperatureOptional | number | 1.0 | Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. |
top_pOptional | number | 1.0 | Randomness setting. Alternative to temperature. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. |
confidenceOptional | number | 0.6 | Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. |
presence_penaltyOptional | number | 0 | Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. |
frequency_penaltyOptional | number | 0 | Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. |
| Name | Type | Default | Description |
|---|---|---|---|
contextsRequired | object | - | An object that defines the available contexts for the AI. Each context represents a set of steps that guide the flow of the conversation. The object must include a default key, which specifies the initial context used at the start of the conversation. Additional contexts can be added as other keys within the object. For more details, see the contexts technical reference. |
textOptional | string | - | The global prompt that can be used along side the contexts step prompts. The prompt here will be retained in the agents memory even when the context or step has changed. |
temperatureOptional | number | 1.0 | Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. |
top_pOptional | number | 1.0 | Randomness setting. Alternative to temperature. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. |
confidenceOptional | number | 0.6 | Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. |
presence_penaltyOptional | number | 0 | Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. |
frequency_penaltyOptional | number | 0 | Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. |
| Name | Type | Default | Description |
|---|---|---|---|
pomRequired | object[] | - | An array of objects that defines the prompt object model (POM) for the AI. The POM is a structured data format for organizing and rendering a prompt for the AI agent. This prompt will be used to define the AI's personality, role, and other characteristics. See the POM technical reference for more information. |
temperatureOptional | number | 1.0 | Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. |
top_pOptional | number | 1.0 | Randomness setting. Alternative to temperature. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. |
confidenceOptional | number | 0.6 | Threshold to fire a speech-detect event at the end of the utterance. Float value between 0.0 and 1.0. Decreasing this value will reduce the pause after the user speaks, but may introduce false positives. |
presence_penaltyOptional | number | 0 | Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. |
frequency_penaltyOptional | number | 0 | Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. |
Variable Expansion
Use the following syntax to expand variables into your prompt.
| Variable | Description |
|---|---|
%{call_direction} | Inbound or outbound. |
%{caller_id_number} | The caller ID number. |
%{local_date} | The local date. |
%{spoken_date} | The spoken date. |
%{local_time} | The local time. |
%{time_of_day} | The time of day. |
%{supported_languages} | A list of supported languages. |
%{default_language} | The default language. |