Parameters for AI that can be passed in ai.params at the top level of the [ai Method](./index.mdx). | Name | Type | Default | Description | |:-|:|:--|:-| | paramsOptional | object | - | An object that accepts the [params parameters](#params-parameters). | ## **params Parameters** | Name | Type | Default | Description | |:-|:-|:--|:| | acknowledge_interruptionsOptional | boolean \| string | - | Instructs the agent to acknowledge crosstalk and confirm user input when the user speaks over the agent. | | ai_volumeOptional | integer | 0 (the natural volume of the AI) | Adjust the volume of the AI. Allowed values from -50-50. | | attention_timeoutOptional | integer | 10000 ms (10 seconds) | Amount of time, in ms, to wait before prompting the user to respond. Allowed values from 10,000-600,000. Set to 0 to disable. | | attention_timeout_promptOptional | string | The user has not responded, try to get their attention. Stay in the same language. | A custom prompt that is fed into the AI when the attention_timeout is reached. | | background_fileOptional | string | 600000 ms (10 minutes) | URL of audio file to play in the background while AI plays in foreground. | | background_file_loopsOptional | integer | undefined (loops indefinitely) | Maximum number of times to loop playing the background file. | | background_file_volumeOptional | string | - | Defines background_file volume within a range of -50 to +50. | | barge_match_stringOptional | string | - | Takes a string, including a regular expression, defining barge behavior. For example, this param can direct the AI to stop when the word hippopotomus is input. | | barge_min_wordsOptional | string | - | Defines the number of words that must be input before triggering barge behavior, in a range of 1-99. | | [conscience](./conscience.mdx)Optional | string | Remember to stay in character. You must not do anything outside the scope of your provided role. | Sets the prompt which binds the agent to its purpose. | | conversation_idOptional | string | - | Used by check_for_input and save_conversation to identify an individual conversation. | | debug_webhook_levelOptional | integer | - | Enables debugging to the set URL. | | debug_webhook_urlOptional | string | - | Each interaction between the AI and end user is posted in real time to the established URL. Authentication can also be set in the url in the format of username:password@url. | | directionOptional | string | the natural direction of the call | Forces the direction of the call to the assistant. Valid values are inbound and outbound. | | digit_terminatorsOptional | string | - | DTMF digit, as a string, to signal the end of input (ex: #) | | digit_timeoutOptional | integer | 3000 ms | Time, in ms, at the end of digit input to detect end of input. Allowed values from 250-10,000. | | eleven_labs_stabilityOptional | number | - | The stability slider determines how stable the voice is and the randomness between each generation. Lowering this slider introduces a broader emotional range for the voice.
**Important**: This will only works when elevenlabs is set in the [ai.languages.voice](../ai_languages.mdx) as the engine id. | | eleven_labs_similarityOptional | number | - | The similarity slider dictates how closely the AI should adhere to the original voice when attempting to replicate it. The higher the similarity, the closer the AI will sound to the original voice.
**Important**: This will only works when elevenlabs is set in the [ai.languages.voice](../ai_languages.mdx) as the engine id. | | end_of_speech_timeoutOptional | integer | 2000 ms (2 seconds) | Amount of silence, in ms, at the end of an utterance to detect end of speech. Allowed values from 250-10,000. | | energy_levelOptional | number | 52 | Amount of energy necessary for bot to hear you (in dB). Allowed values from 0.0-100.0. | | [hold_music](./hold_music.mdx)Optional | string | - | A URL for the hold music to play, accepting WAV, mp3, and [FreeSWITCH tone_stream](https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Modules/mod-dptools/mod-dptools:-gentones/Tone_stream_6586599/). | | hold_on_processOptional | boolean | - | Enables hold music during SWAIG processing. | | inactivity_timeoutOptional | integer | 600000 ms (10 minutes) | Amount of time, in ms, to wait before exiting the app due to inactivity. Allowed values from 10,000-3,600,000. | | input_poll_freqOptional | string | - | Check for input function with check_for_input. Example use case: Feeding an inbound SMS to AI on a voice call, eg., for collecting an email address or other complex information. | | interrupt_on_noiseOptional | boolean | - | When enabled, barges agent upon any sound interruption longer than 1 second. | | [interrupt_prompt](./interrupt_prompt.mdx)Optional | string | - | Provide a prompt for the agent to handle crosstalk. | | languages_enabledOptional | boolean | - | Allows multilingualism when true. | | local_tzOptional | string | GMT | The local timezone setting for the AI. Value should use [IANA TZ ID](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | | outbound_attention_timeoutOptional | integer | - | Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from 10000 to 600000. | | save_conversationOptional | boolean | false | Send a summary of the conversation after the call ends. This requires a post_url to be set in the [ai parameters](./index.mdx#params-parameters) and the conversation_id defined below. This eliminates the need for a post_prompt in the ai parameters. | | swaig_allow_settingsOptional | boolean | - | Allows tweaking any of the indicated settings, such as barge_match_string, using the returned SWML from the SWAIG function. | | swaig_allow_swmlOptional | boolean | - | Allows your SWAIG to return SWML to be executed. | | swaig_post_conversationOptional | boolean | - | Post entire conversation to any SWAIG call. | | transfer_summaryOptional | boolean | - | Pass a summary of a conversation from one AI agent to another. For example, transfer a call summary between support agents in two departments. | | verbose_logsOptional | boolean | - | Enable verbose logging. | | wait_for_userOptional | boolean | false | When false, AI agent will initialize dialogue after call is setup. When true, agent will wait for the user to speak first. |