AIAgentConfig

Updated at:

Parameter

Type

Description

Example

object

The agent template parameters.

Greeting

string

The greeting message. Changes take effect in the next session. Default value: none.

hello

WakeUpQuery

string

The user instruction before the call starts. The agent responds to this instruction immediately after the call starts.

How’s the weather today?

MaxIdleTime

integer

The maximum idle time without interaction with the agent. The agent goes offline upon timeout. Unit: seconds. Default value: 600.

600

UserOnlineTimeout

integer

The timeout period for the agent to close the task if the user does not join the session. Unit: seconds. Default value: 60.

60

UserOfflineTimeout

integer

The timeout period for the agent to close the task after the user leaves the session. Unit: seconds. Default value: 5.

5

EnablePushToTalk

boolean

Specifies whether to enable the push-to-talk mode. Default value: false.

false

GracefulShutdown

boolean

Specifies whether to enable graceful shutdown. Default value: false.

Graceful shutdown: When the agent is stopped, it finishes broadcasting the current speech before stopping, for a maximum of 10 seconds.

false

Volume

integer

The volume of the agent's speech.

  • If not specified: The adaptive volume mode recommended by Alibaba Cloud is used by default.

  • If specified: The valid range is 0 to 400. Output volume = Speech output volume in the workflow × volume / 100. Examples:

  1. If volume is set to 0, the output volume is 0.

  2. If volume is set to 100, the output volume is the original volume.

  3. If volume is set to 200, the output volume is twice the original volume.

100

WorkflowOverrideParams

string

The workflow override parameters. Default value: none.

{}

AvatarUrl

string

The avatar URL of the agent for voice calls. Default value: none.

http://example.com/a.jpg

AvatarUrlType

string

The type of the agent avatar URL. Default value: none.

USER

EnableIntelligentSegment

boolean

Specifies whether to enable intelligent segmentation. After this feature is enabled, fragmented sentences spoken by the user are intelligently merged into a single sentence. Default value: true.

true

AsrConfig

object

The automatic speech recognition (ASR) configuration.

AsrLanguageId

string

The ASR language ID. Valid values:

  • zh_mandarin: Chinese.

  • en: English.

  • zh_en: Mixed Chinese and English.

  • es: Spanish.

  • jp: Japanese.

zh_mandarin

AsrMaxSilence

integer

The silence duration threshold for speech segmentation. Silence exceeding this threshold is considered a sentence break. Valid values: 200 to 1200. Unit: milliseconds. Default value: 400.

400

AsrHotWords

array

The ASR hot word list. The list supports a maximum of 128 hot words.

string

The hot word string. Length: 1 to 10 characters.

check

VadLevel

integer

The interruption threshold parameter. Valid values: 0 to 11. Default value: 11.

  • 0: Disables the voice activity detection (VAD) feature.

  • 1 to 10: A higher value indicates that it is more difficult to interrupt the agent.

  • 11: Significantly different from previous values, providing lower speech distortion during pre-processing and stronger anti-interference capability.

11

CustomParams

string

The pass-through parameters for the proprietary ASR integration.

mode=fast&sample=16000&format=wav

VadDuration

integer

The minimum duration threshold for voice activity detection, which is used to control the interruption sensitivity. A value of 0 disables this feature. Valid values: 200 to 2000. Unit: milliseconds. Common values: 200 to 500, which correspond to 1 to 4 words. Default value: empty (does not take effect).

300

TtsConfig

object

The speech synthesis configuration.

VoiceId

string

The voice ID. Changes take effect in the next sentence. If not specified, the voice ID configured in the agent template is used. This parameter takes effect only for preset TTS. Maximum length: 64 characters. For valid values, refer to Intelligent speech effect examples.

longcheng_v2

VoiceIdList

array

The list of available voices.

string

The voice.

zhixiaoxia

PronunciationRules

array

The TTS pronunciation rules. The array length cannot exceed 20. The rules are executed in sequence.

object

The TTS pronunciation rule.

Word

string

The word to be replaced. The length must be less than 10 characters. It must consist of Chinese characters and cannot contain spaces.

110

Pronunciation

string

The target pronunciation. The length must be less than 10 characters. It must consist of Chinese characters and cannot contain spaces.

110

Type

string

The specific pronunciation rule type. Valid values:

  • replacement: The rule that directly replaces the Word with the Pronunciation.

replacement

ModelId

string

The model ID. Currently, only minimax is supported. Valid values: speech-01-turbo or speech-02-turbo.

speech-01-turbo

LanguageId

string

The language ID. Currently, only minimax is supported. Default value: empty. This parameter enhances the recognition capability for specified minority languages and dialects. After configuration, it improves speech performance in specified minority language or dialect scenarios. If the minority language type is unclear, you can set this parameter to "auto", and the model will automatically determine the language type. Valid values:

Supported languages

  • Chinese: Chinese

  • Chinese,Yue: Cantonese

  • English: English

  • Arabic: Arabic

  • Russian: Russian

  • Spanish: Spanish

  • French: French

  • Portuguese: Portuguese

  • German: German

  • Turkish: Turkish

  • Dutch: Dutch

  • Ukrainian: Ukrainian

  • Vietnamese: Vietnamese

  • Indonesian: Indonesian

  • Japanese: Japanese

  • Italian: Italian

  • Korean: Korean

  • Thai: Thai

  • Polish: Polish

  • Romanian: Romanian

  • Greek: Greek

  • Czech: Czech

  • Finnish: Finnish

  • Hindi: Hindi

  • auto: Automatic detection

Chinese

Emotion

string

The emotion. Currently, only minimax is supported. minimax supports the following 7 emotions:

  • happy: Happy

  • sad: Sad

  • angry: Angry

  • fearful: Fearful

  • disgusted: Disgusted

  • surprised: Surprised

  • calm: Calm

happy

SpeechRate

number

The speech rate. Supported on all platforms. For cosyvoice, the default value is 1.0, and the valid range is 0.5 to 2.0. For minimax, the default value is 1.0, and the valid range is 0.5 to 2.0.

1.0

LlmConfig

object

The large language model (LLM) configuration.

LlmHistory

array

The historical conversation context of the LLM or multimodal LLM (MLLM).

object

A single conversation.

Role

string

The role of the conversation participant. Valid values:

  • user: User

  • assistant: Assistant

  • system: System

  • function: Function

  • plugin: Plugin

  • tool: Tool

user

Content

string

The actual text content of the conversation, which records the specific expression or response of the role in the conversation.

hello

LlmHistoryLimit

integer

The maximum number of retained turns for the historical conversation context of the LLM or MLLM. Default value: 10.

10

LlmSystemPrompt

string

The system prompt for the LLM after the call starts.

You are the 1 friendly and helpful assistant, focused on providing accurate information and advice to users.

BailianAppParams

string

The parameters for Alibaba Cloud Model Studio Application Center. The type is a JSON string. For the parameter format, refer to: Alibaba Cloud Model Studio Application Center parameters.

"{\"biz_params\":{\"user_defined_params\":{\"your_plugin_id\":{\"article_index\":2}}},\"memory_id\":\"your_memory_id\",\"image_list\":[\"https://your_image_url\"],\"rag_options\":{\"pipeline_ids\":[\"your_id\"],\"file_ids\":[\"DocumentID1\",\"DocumentID2\"],\"metadata_filter\":{\"name\":\"ZhangSan\"},\"structured_filter\":{\"key1\":\"value1\",\"key2\":\"value2\"},\"tags\":[\"Tag1\",\"Tag2\"]}}"

OpenAIExtraQuery

string

The additional query parameters for the OpenAI-compatible LLM. Parameters must be in the key=value format. Multiple parameters are connected by an ampersand (&). All values must be of the string type.

api-version=2024-02-01&api-key=sk-xxx

LlmCompleteReply

boolean

After this feature is enabled, the agent sends the complete LLM result to the client after the LLM generates the full response. This switch does not affect the streaming generation of subtitles.

true

FunctionMap

array

The function mapping list, which is used to map agent capabilities to LLM functions. Currently, only function calling with user-defined OpenAI-compatible LLMs is supported.

object

A single mapping rule.

Function

string

The name of the built-in feature provided by the Alibaba Cloud agent system. Currently, only hangup (hang up) is supported.

hangup

MatchFunction

string

The name of the LLM function that corresponds to this feature. This name is customized by the user and used to call the corresponding feature in the LLM. For user-defined LLM protocols, refer to Standard LLM API.

hangup

OutputMinLength

integer

The minimum length of text output in characters. Text shorter than this length is cached and waiting for concatenation. Valid values: 0 to 100. A value of 0 or empty indicates no limit. Default value: empty.

5

OutputMaxDelay

integer

The maximum delay time for text output in milliseconds. If this time is exceeded, the cached text is forcibly output. Valid values: 1000 to 10000. A value of 0 or empty indicates no limit. Default value: empty.

2000

HistorySyncWithTTS

boolean

Specifies whether the LLM message history is consistent with the TTS playback content. Default value: false. After this feature is enabled, the saved LLM messages are consistent with the TTS playback content.

Note

In the LLM message history, when the user interrupts the agent, the next message sent to the LLM will insert the <ims_agent_interrupted> tag at the interruption position. Example:

[
  {"role": "user", "content": "Tell me a story."},
  {"role": "assistant", "content": "Sure, let me tell you a story about the Romance of the Three Kingdoms. Do you<ims_agent_interrupted> want to listen?"},
  {"role": "user", "content": "Let's change to another one."}
]

false

AvatarConfig

object

The digital human configuration. This configuration takes effect only when the workflow includes a digital human node.

AvatarId

string

The model ID of the digital human.

5257

InterruptConfig

object

The voice interruption policy configuration.

EnableVoiceInterrupt

boolean

Specifies whether to support voice interruption. Default value: true.

true

InterruptWords

array

The list of specific words or phrases that trigger conversation interruption.

string

A specific word or phrase that triggers conversation interruption.

Excuse me

NoInterruptMode

string

The ASR processing policy in mode.

  • cache: Caches the ASR text. After the current turn ends, the cached ASR text is processed together in the next turn.

  • discard: Discards the ASR text directly.

The default policy is to cache the ASR text.

cache

KeepInterruptWordsForLLM

boolean

Specifies whether to retain interruption words when sending text to the LLM. Default value: discard.

Note

Example: If the interruption word is "wait", the sentence "wait how is the weather today" becomes "how is the weather today" after the interruption word is discarded and sent to the LLM.

true

VoiceprintConfig

object

The voiceprint configuration.

UseVoiceprint

boolean

Specifies whether to enable voiceprint recognition. Default value: false. When voiceprint recognition is enabled, a valid voiceprint ID must be passed.

false

VoiceprintId

string

The unique identity ID for voiceprint recognition. Default value: empty. The passed voiceprint ID must have been registered through the voiceprint registration API. For the API documentation, refer to Register voiceprint.

zhixiaoxia

RegistrationMode

string

The voiceprint registration mode. Default value: Explicit.

ValueDescription
ExplicitExplicit registration mode. Users must upload audio through the voiceprint registration API in advance to complete registration.
ImplicitImplicit registration mode. User voice is automatically collected during the conversation to generate voiceprint features.

Explicit

TurnDetectionConfig

object

The conversation turn detection configuration.

TurnEndWords

array

The list of keywords used to determine the end of a user's turn.

string

A keyword used to determine the end of a user's turn.

I'm done

Mode

string

The turn detection mode.

  • Normal (default): Normal mode. AI is not used to determine semantics.

  • Semantic: Semantic mode. AI is used to determine whether the user has finished speaking based on the context semantics.

Semantic

SemanticWaitDuration

integer

The pause determination time in AI mode. Unit: milliseconds. Default value: -1.

  • -1: AI automatically determines the appropriate waiting time.

  • 0 to 10000: Custom waiting time. We recommend that you set it to 0 to 1500 milliseconds.

Note

This parameter is invalid in normal mode.

-1

Eagerness

string

The eagerness level. This parameter takes effect only in Semantic mode. It controls the response speed after the AI detects a pause:

  • "Low": Patient waiting. The maximum waiting time is 6 seconds, which reduces the risk of being interrupted.

  • "Medium": Balanced waiting. The maximum waiting time is 4 seconds, which is suitable for most scenarios.

  • "High": Fast response. The maximum waiting time is 2 seconds, which improves speed but may increase the risk of false cuts.

Default value: empty.

High

ExperimentalConfig

string

The experimental feature parameters. Contact technical support if you have any requirements.

""

VcrConfig

object

The video content recognition feature configuration. This configuration supports calling back the content recognized by the algorithm in the video to the client.

StillFrameMotion

object

The still frame detection configuration.

Enabled

boolean

Specifies whether to enable still frame detection. Default value: false.

false

CallbackDelay

integer

The delay for still frame detection notifications. After this parameter is set, a notification is triggered after a still frame lasts for a specified period of time. Unit: milliseconds. Default value: empty. If empty, the configuration in the console is used during the call. Valid values: 200 to 5000.

3000

InvalidFrameMotion

object

The invalid frame detection parameter settings.

Enabled

boolean

Specifies whether to enable invalid frame detection.

false

CallbackDelay

integer

The delay for invalid frame detection notifications. After this parameter is set, a notification is triggered after an invalid frame lasts for a specified period of time. Unit: milliseconds. Default value: empty. If empty, the configuration in the console is used during the call. Valid values: 200 to 5000.

3000

PeopleCount

object

The people counting feature configuration.

Enabled

boolean

Specifies whether to enable the feature. Default value: false.

false

Equipment

object

The equipment recognition configuration.

Enabled

boolean

Specifies whether to enable prohibited equipment detection. Default value: false.

false

HeadMotion

object

The head motion recognition configuration.

Enabled

boolean

Specifies whether head motion recognition is enabled. Default value: false.

false

LookAway

object

The look-away detection configuration.

Enabled

boolean

Specifies whether look-away detection is enabled. Default value: false.

true

AmbientSoundConfig

object

The ambient sound configuration for calls.

ResourceId

string

The ID of the ambient sound for calls. You can obtain this ID in the advanced settings of the agent configuration in the console.

f67901c595834************

Volume

integer

The volume of the background sound for calls. Valid values: 0 to 100. A value of 0 indicates that the background sound is disabled.

50

AutoSpeechConfig

object

The automatic speech configuration module for the agent, including LLM wait prompts and inquiries during prolonged user silence.

UserIdle

object

The configuration for inquiry prompts during prolonged user silence.

WaitTime

integer

The silence duration threshold in milliseconds. This parameter is required. An inquiry is triggered when the silence duration exceeds this threshold. Valid values: 5000 to 600000.

5000

MaxRepeats

integer

The maximum number of inquiries. This parameter is required. Valid values: 0 to 10. After the maximum number is reached, no more inquiries are triggered and the call is disconnected.

5

Messages

array

The collection of inquiry prompts. A maximum of 10 prompts are supported. Each prompt can be up to 100 characters in length. The sum of probabilities must be 100%.

object

The inquiry prompt structure.

Text

string

The text of the inquiry prompt. Maximum length: 100 characters.

Are you still there?

Probability

number

The selection probability of the prompt. Valid values: 0 to 1, which corresponds to 0% to 100%.

0.5

HangupEndWord

string

The hang-up closing remark. This remark is broadcast before the call is disconnected after a prolonged period of user unresponsiveness. Maximum length: 200 characters.

I'm hanging up, bye

LlmPending

object

The configuration for prompts during LLM response delays.

WaitTime

integer

The wait time threshold for LLM responses in milliseconds. This parameter is required. A prompt is triggered when the wait time exceeds this threshold. Valid values: 500 to 10000. Set this value based on the actual response time of the LLM.

3000

Mode

string

Messages

array

The collection of inquiry prompts. A maximum of 10 prompts are supported. Each prompt can be up to 100 characters in length. The sum of probabilities must be 100%.

object

The inquiry prompt structure.

Text

string

The text of the inquiry prompt. Maximum length: 100 characters.

Just a moment

Probability

number

The selection probability of the prompt. Valid values: 0 to 1, which corresponds to 0% to 100%.

0.5

BackChannelingConfigs

array

The backchanneling configuration module. When enabled, the system randomly broadcasts short backchanneling words at specific trigger stages.

object

The configuration for a single backchanneling item.

Enabled

boolean

Specifies whether the backchanneling feature is enabled. This parameter is required. Valid values: true and false.

true

TriggerStage

string

The trigger stage for backchanneling. Valid values:

  • pause_detected: A short pause in speech is detected.

pause_detected

Probability

number

The trigger probability of the feature. Valid values: 0.0 to 1.0. This parameter is required.

0.5

Words

array

The collection of backchanneling phrases. A maximum of 10 phrases are supported. Each phrase can be up to 20 characters in length. The sum of probabilities must be 1.0.

object

The configuration for a backchanneling phrase.

Text

string

The text of the phrase. Maximum length: 20 characters. Multiple languages are supported. This parameter is required.

ok

Probability

number

The trigger probability of the phrase. Valid values: 0.0 to 1.0. This parameter is required.

0.3

BackChannelingConfig

array

Important [Deprecated] Use BackChannelingConfigs instead.

object

The configuration for a single backchanneling item.

Enabled

boolean

Specifies whether the backchanneling feature is enabled. This parameter is required. Valid values: true and false.

true

TriggerStage

string

The trigger stage for backchanneling. Valid values:

  • pause_detected: A short pause in speech is detected.

pause_detected

Probability

number

The trigger probability of the feature. Valid values: 0.0 to 1.0. This parameter is required.

0.5

Words

array

The collection of backchanneling phrases. A maximum of 10 phrases are supported. Each phrase can be up to 20 characters in length. The sum of probabilities must be 1.0.

object

The configuration for a backchanneling phrase.

Text

string

The text of the phrase. Maximum length: 20 characters. Multiple languages are supported. This parameter is required.

ok

Probability

number

The trigger probability of the phrase. Valid values: 0.0 to 1.0. This parameter is required.

0.3