VoiceAgentSubagent interface

Package:

@azure/ai-projects

A sibling Foundry text agent that a voice agent may consult as a background specialist.

Properties

agent_capabilities	A description of the subagent's capabilities, used by the voice agent to decide whether to forward a query.
agent_name	The name of the subagent. The subagent must be in the same project as the voice agent.
agent_version	The version of the subagent. When omitted, the active version is used.
invoke_timeout_seconds	The wall-clock timeout, in seconds, for each invocation of this subagent. When omitted, the service timeout is used.
response_policy	Policy for acknowledging forwarded requests and filling gaps while waiting for this subagent's response.

Property Details

agent_capabilities

A description of the subagent's capabilities, used by the voice agent to decide whether to forward a query.

agent_capabilities: string

Property Value

string

agent_name

The name of the subagent. The subagent must be in the same project as the voice agent.

agent_name: string

Property Value

string

agent_version

The version of the subagent. When omitted, the active version is used.

agent_version?: string

Property Value

string

invoke_timeout_seconds

The wall-clock timeout, in seconds, for each invocation of this subagent. When omitted, the service timeout is used.

invoke_timeout_seconds?: number

Property Value

number

response_policy

Policy for acknowledging forwarded requests and filling gaps while waiting for this subagent's response.

response_policy?: VoiceAgentSubagentResponsePolicy

Property Value

VoiceAgentSubagentResponsePolicy