AgentSessionConfig interface

Package:

@azure/ai-voicelive

Configuration for creating a session with an agent as the main AI actor.

When using an agent session, the agent's configuration (tools, instructions, temperature, etc.) is managed in the Foundry portal, not in session code.

Remarks

This is distinct from AgentConfig which represents agent information returned by the service in session responses.

Properties

agentName	The name of the Foundry agent to use
agentVersion	The version of the agent to use. If not specified, the latest version will be used.
authenticationIdentityClientId	The client ID of a user-assigned managed identity used for authenticating to the Foundry Agent service. If not specified, the system-assigned managed identity will be used.
conversationId	The conversation ID to continue. If not specified, a new conversation will be created.
foundryResourceOverride	The Foundry resource name to use for cross-resource agent mode. When set, the agent service endpoint will use this resource instead of the one from the connection URL.
projectName	The name of the Azure AI project which the agent belongs to

Property Details

agentName

The name of the Foundry agent to use

agentName: string

Property Value

string

agentVersion

The version of the agent to use. If not specified, the latest version will be used.

agentVersion?: string

Property Value

string

authenticationIdentityClientId

The client ID of a user-assigned managed identity used for authenticating to the Foundry Agent service. If not specified, the system-assigned managed identity will be used.

authenticationIdentityClientId?: string

Property Value

string

conversationId

The conversation ID to continue. If not specified, a new conversation will be created.

conversationId?: string

Property Value

string

foundryResourceOverride

The Foundry resource name to use for cross-resource agent mode. When set, the agent service endpoint will use this resource instead of the one from the connection URL.

foundryResourceOverride?: string

Property Value

string

projectName

The name of the Azure AI project which the agent belongs to

projectName: string

Property Value

string