AIAgentConfig

Updated at:

Parameter

Type

Description

Example

object

The agent template parameters.

AmbientSoundConfig

object

The call ambient sound configuration.

ResourceId

string

The ID of the call ambient sound. You can obtain the ID from the advanced settings of the agent configuration in the console.

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

Volume

integer

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

50

AsrConfig

object

The speech recognition configuration.

AsrContext

string

The ASR context enhancement.

[{"role":"user","content":[{"type":"input_text","text":"Alibaba Cloud, Qwen, Qwen-Audio"}]},{"role":"assistant","content":[{"type":"text","text":"Okay, I will incorporate these terms into our conversation."}]}]

AsrHotWords

array

The ASR hotword list. The list supports a maximum of 128 hotwords.

string

The hotword string. The length ranges from 1 to 10 characters.

check

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 threshold for speech segmentation detection. If the silence duration exceeds this threshold, the speech is considered segmented. Valid values: 200 to 1200. Unit: milliseconds. Default value: 400.

400

AsrVocabulary

string

The instance-level real-time hotwords and their weights for ASR.

{"Qwen":4,"Qwen-Audio":5,"Alibaba Cloud Speech Lab":50}

CustomParams

string

The pass-through parameters for custom ASR integration.

mode=fast&sample=16000&format=wav

VadDuration

integer

The minimum duration threshold for voice activity detection (VAD), which is used to control the sensitivity of interruptions. A value of 0 indicates that this feature is disabled. Valid values: 200 to 2000. Unit: milliseconds. Common values range from 200 to 500, which correspond to 1 to 4 words. Default value: null. If this parameter is left empty, this feature does not take effect.

300

VadLevel

integer

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

  • 0: Disables the VAD feature.

  • 1 to 10: A larger value indicates that it is more difficult to trigger an interruption.

  • 11: Significantly different from previous values. It causes less damage to the pre-processed conversation audio and provides stronger anti-interference capability.

11

AutoSpeechConfig

object

The automatic speech configuration module for the agent, which includes prompts for LLM response delays and inquiries during prolonged user silence.

LlmPending

object

The broadcast configuration for LLM response delays.

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.

Probability

number

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

0.5

Text

string

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

Just a moment

Mode

string

The mode for selecting the soothing prompt from LlmPending.Messages to broadcast while waiting for the agent to reply. Valid values:

  • ai_select: The AI selects the most appropriate prompt from Messages based on the current conversation. This mode does not check whether the sum of Probability values is 1, but WaitTime cannot be less than 800 milliseconds. This is the default value.

  • probability: A prompt is randomly selected based on the Probability weight of each prompt. The sum of all Probability values must be exactly 1.0.

ai_select

WaitTime

integer

The threshold for the waiting time for a response from the large language model (LLM). If the waiting time exceeds this threshold, a broadcast prompt is triggered. This parameter is required. Valid values: 500 to 10000. Unit: milliseconds. Set this parameter based on the actual usage of the LLM.

3000

UserIdle

object

The broadcast configuration for inquiries during prolonged user silence.

HangupEndWord

string

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

I'm hanging up, bye

MaxRepeats

integer

The maximum number of inquiries. Valid values: 0 to 10. This parameter is required. If the number of inquiries exceeds this value, no more inquiries are triggered and the call is directly closed.

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.

Probability

number

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

0.5

Text

string

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

Are you still there?

WaitTime

integer

The silence duration threshold. This parameter is required. If the silence duration exceeds this threshold, an inquiry is triggered. Valid values: 5000 to 600000. Unit: milliseconds.

5000

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

Resolution

string

The resolution of the digital human video stream. The value must be in strictly lowercase letters and must be specified together with AvatarId. Valid values:

  • 360p

  • 480p

  • 720p

  • 1080p

1080p

TemplateId

string

The ID of the digital human template, which specifies the template used when the digital human is started. The template is provided by the digital human service provider, and the provider also verifies whether the specified value is valid.

tpl-9527

AvatarUrl

string

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

http://example.com/a.jpg

AvatarUrlType

string

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

USER

BackChannelingConfig

array

[Deprecated] Use BackChannelingConfigs instead.

object

The configuration of a single backchanneling phrase.

Enabled

boolean

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

true

Probability

number

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

0.5

TriggerStage

string

The trigger stage for backchanneling. Valid values:

  • pause_detected: A short pause in speech is detected.

pause_detected

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 of a backchanneling phrase.

Probability

number

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

0.3

Text

string

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

ok

BackChannelingConfigs

array

The backchanneling feature configuration module. After this feature is enabled, the system randomly broadcasts short backchanneling phrases at specific trigger stages.

object

The configuration of a single backchanneling phrase.

Enabled

boolean

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

true

Probability

number

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

0.5

TriggerStage

string

The trigger stage for backchanneling. Valid values:

  • pause_detected: A short pause in speech is detected.

pause_detected

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 of a backchanneling phrase.

Probability

number

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

0.3

Text

string

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

ok

EnableIntelligentSegment

boolean

Specifies whether to enable intelligent segmentation. After intelligent segmentation is enabled, segmented speech from the user is intelligently merged into a single sentence. Default value: true.

true

EnablePushToTalk

boolean

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

false

ExperimentalConfig

string

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

""

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 shutting down. The maximum broadcast duration is 10 seconds.

false

Greeting

string

The greeting. Modifications take effect the next time the user joins the call. Default value: none.

hello

InterruptConfig

object

The speech interruption policy configuration.

EnableVoiceInterrupt

boolean

Specifies whether to support speech 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

KeepInterruptWordsForLLM

boolean

Specifies whether to retain interrupt words when sending messages to the LLM. By default, interrupt words are discarded. For example, if the interrupt word is "wait", the message "wait how is the weather today" is changed to "how is the weather today" after the interrupt word is discarded.

true

NoInterruptMode

string

The ASR processing policy in No Interrupting mode. Valid values:

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

  • discard: Directly discards the ASR text. Default value: cache.

cache

LlmConfig

object

The large language model (LLM) configuration.

BailianAppParams

string

The parameters for Alibaba Cloud Model Studio. The value must be a JSON string. For more information about the parameter format, see Alibaba Cloud Model Studio 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\"]}}"

FunctionMap

array

The function mapping list, which is used to map agent capabilities to LLM functions. Currently, only function calling with user-defined LLMs that use the OpenAI protocol 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 is supported.

hangup

MatchFunction

string

The name of the LLM function that corresponds to the feature. This name is customized by the user and is used to call the corresponding feature in the LLM. For more information about the user-defined LLM protocol, see Standard LLM API.

hangup

HistorySyncWithTTS

boolean

Specifies whether to keep the LLM message history consistent with the text-to-speech (TTS) playback content. Default value: false. After this feature is enabled, the saved LLM messages are kept consistent with the TTS playback content. When the user interrupts the agent in the LLM message history, the <ims_agent_interrupted> tag is inserted at the interruption position in the next message sent to the LLM. Example:

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

false

LlmCompleteReply

boolean

Specifies whether to send the complete LLM result to the client after the LLM generates the complete response. This switch does not affect the streaming generation of subtitles.

true

LlmHistory

array

The historical conversation context of the LLM or multimodal LLM.

object

A single conversation.

Content

string

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

hello

Role

string

The role of the conversation participant. Valid values:

  • user: User.

  • assistant: Assistant.

  • system: System.

  • function: Function.

  • plugin: Plugin.

  • tool: Tool.

user

LlmHistoryLimit

integer

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

10

LlmSystemPrompt

string

The system prompt for the LLM after the call is started.

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

OpenAIExtraQuery

string

The extra 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

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

OutputMinLength

integer

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

5

MaxIdleTime

integer

The maximum wait time without interaction with the agent. If this time is exceeded, the agent goes offline. Unit: seconds. Default value: 600.

600

TransferCallConfig

object

The configuration for Real-Time Communication (RTC) call transfer. When you call ForwardAIAgentCall to transfer an RTC call (CallMode=0) to a regular phone, use this configuration to specify the line and the caller number. Transfer is available only if CallerNumber is configured. If it is not configured, a 400 error is returned when you call the transfer API operation. This configuration is read only once when the instance starts. Modifications during a call do not take effect. This configuration does not apply to inbound and outbound call transfers. Use InboundCallConfig and OutboundCallConfig instead.

CalledNumber

string

The default transfer number. This is a backup number. You must still explicitly pass the called number when you initiate a transfer call.

0571xxxxxxx

CallerNumber

string

The caller number used for transfer calls. Configuring this field enables the RTC transfer capability. If this field is not configured, the behavior remains unchanged.

0571xxxxxxx

ForwardTranscriptionEnabled

boolean

Specifies whether to perform real-time speech recognition for both parties (the RTC user and the transferred phone party) after the transfer is connected. When enabled, the recognition results are pushed to the client as subtitles through the RTC message channel and written to the call record. Valid values:

  • true: Enabled. This is the default value.

  • false: Disabled. Subtitles and call records are not generated during the transfer.

false

SipDomain

string

The custom SIP outbound gateway address. This parameter is required only when Type is set to 1.

sip.example.com:5060

Type

integer

Valid values:

  • 0: Alibaba Cloud communication line. This is the default value.

  • 1: Custom SIP line.

1

TtsConfig

object

The speech synthesis configuration.

Emotion

string

The emotion of the voice. Currently, only MiniMax is supported. MiniMax supports the following seven emotions:

  • happy: Happy

  • sad: Sad

  • angry: Angry

  • fearful: Fearful

  • disgusted: Disgusted

  • surprised: Surprised

  • calm: Calm

happy

HotFix

string

The TTS pronunciation correction and text replacement configuration.

{"pronunciation":[{"weather":"tian1 qi4"}],"replace":[{"today":"golden day"}]}

Instruction

string

The natural language instruction control for TTS.

Please use a gentle and friendly female voice, and broadcast at a slightly slower speed

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. Setting this parameter improves the voice performance in the specified minority language or dialect scenarios. If the minority language type is not specified, you can set this parameter to auto, and the model automatically determines 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

ModelId

string

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

speech-01-turbo

PronunciationRules

array

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

object

The TTS pronunciation rule.

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: A rule that directly replaces Word with Pronunciation.

replacement

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

SpeechRate

number

The speech rate. This parameter is supported on all platforms. For CosyVoice, the default value is 1.0, and the valid values range from 0.5 to 2.0. For MiniMax, the default value is 1.0, and the valid values range from 0.5 to 2.0.

1.0

VoiceId

string

The voice ID. Modifications take effect in the next sentence. If you do not specify this parameter, the voice ID configured in the agent template is used. This parameter takes effect only for preset TTS. The input length cannot exceed 64 characters. For valid values, refer to Intelligent speech effect examples.

longcheng_v2

VoiceIdList

array

The list of available voices.

string

The voice.

zhixiaoxia

TurnDetectionConfig

object

The turn detection configuration.

Eagerness

string

The eagerness level. This parameter takes effect only in Semantic mode. It controls how quickly the AI starts to respond after detecting a pause:

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

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

  • High: Fast response. The maximum wait time is 2 seconds, which improves speed but may increase the risk of false cut-offs. Default value: empty.

High

Mode

string

The turn detection mode. Valid values:

  • Normal: Normal mode. AI is not used to determine semantics. This is the default value.

  • 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. Valid values:

  • -1: The AI automatically determines the appropriate wait time.

  • 0 to 10000: A custom wait time. We recommend that you set this value to 0 to 1500 milliseconds.

Note

This parameter is invalid in Normal mode.

-1

TurnEndWords

array

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

string

The keyword used to determine the end of a user turn.

I'm done

UserOfflineTimeout

integer

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

5

UserOnlineTimeout

integer

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

60

VcrConfig

object

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

Equipment

object

The equipment recognition configuration.

Enabled

boolean

Specifies whether to enable the disabled equipment check. Default value: false.

false

HeadMotion

object

The head motion recognition configuration.

Enabled

boolean

Specifies whether to enable the head motion recognition check. Default value: false.

false

InvalidFrameMotion

object

The parameter settings for the invalid frame check.

CallbackDelay

integer

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

3000

Enabled

boolean

Specifies whether to enable the invalid frame check.

false

LookAway

object

The look-away recognition configuration.

Enabled

boolean

Specifies whether to enable the look-away recognition configuration. Default value: false.

true

PeopleCount

object

The configuration for the people counting feature.

Enabled

boolean

The switch for the people counting feature. Default value: false.

false

StillFrameMotion

object

The configuration for the still frame detection.

CallbackDelay

integer

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

3000

Enabled

boolean

Specifies whether to enable the still frame check. Default value: false.

false

VoiceprintConfig

object

The voiceprint configuration.

RegistrationMode

string

The voiceprint registration mode. Default value: Explicit.

ValueDescription
ExplicitExplicit registration mode. Users must upload audio through the voiceprint registration API operation in advance to complete the registration.
ImplicitImplicit registration mode. The system automatically collects the user's voice and generates voiceprint features during the conversation.

Explicit

UseVoiceprint

boolean

Specifies whether to use 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 be registered through the voiceprint registration API operation. For more information about the API operation, refer to Register human voiceprint.

zhixiaoxia

Volume

integer

The volume of the agent's voice.

  • If you do not specify this parameter, the adaptive volume mode recommended by Alibaba Cloud is used by default.

  • If you specify this parameter, the valid values range from 0 to 400. Output volume = Voice 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

WakeUpQuery

string

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

How’s the weather today?

WorkflowOverrideParams

string

The workflow override parameters. Default value: none.

{}