VoiceAgentDefinition interface

Pakket:

@azure/ai-projects

De definitie van de voice agent. De configuratie (model, instructies, audio, tools en optionele avatar) zorgt voor een beheerde spraak-naar-spraak ervaring. Zet realtime spraaksessies op via GET /agents/{agent_name}/endpoint/protocols/voice. Elke creatie of update levert een nieuwe, onveranderlijke versie op.

Uitbreiding

AgentDefinition

Eigenschappen

audio	De audioconfiguratie, inclusief invoer- en uitvoerformaten, spraak, draaidetectie, ruisonderdrukking en transcriptie. Deze waarden zijn sessiestandaarden; een client kan ondersteunde velden overschrijven bij het verbinden.
avatar	Optionele avatarconfiguratie. Deze waarden zijn sessiestandaardwaarden en kunnen worden overschreven bij het verbinden.
conversation_engine	De engine die de gespreksafhandeling voor deze spraakagent beheert. Precies één van deze eigenschap en de model-backed configuratie (model_type met model) moet worden verstrekt. Wanneer deze eigenschap wordt gegeven, model_type, model, instructions, , toolsmoeten tool_choice en worden weggelaten, en greeting.tool_choice kan niet , requiredomdat de engine eigenaar is van de conversatielogica. De eerste implementatie ondersteunt een hosted-agent engine.
greeting	Optionele sessie-start begroeting. Template-modus spreekt exacte gerenderde tekst; LLM-gegenereerde modus vraagt het sessiemodel om het openingsantwoord te schrijven en kan geconfigureerde tools gebruiken.
include	Extra velden om in service-output op te nemen.
instructions	Een systeembericht (of ontwikkelaarsbericht) dat is ingevoegd binnen de context van het model. Ondersteunt sjabloonvervanging via structured_inputs, gerenderd per sessie voordat de live sessie begint.
interim_response	Interim-responsinstellingen voor latentie en tool-uitvoering.
kind	De soort discriminator voor een definitie van een stemagent. Altijd voice.
max_output_tokens	Het maximale aantal outputtokens voor één respons.
model	Het model om voor dit middel te gebruiken. Vereist voor model_type een model-ondersteunde stemagent en weggelaten wanneer conversation_engine deze wordt verstrekt. Het model moet realtime of gecascadeerde spraak ondersteunen.
model_type	Hoe het model achter deze voice agent wordt bediend. Vereist voor model een model-ondersteunde stemagent en weggelaten wanneer conversation_engine deze wordt verstrekt. Dit is onafhankelijk van de architectuur (realtime of gecascadeerd), die de service afleidt van het gekozen model.
output_modalities	De outputmodaliteiten die de agent produceert. Wordt standaard ingesteld op ["audio"]. animation en avatar zijn beschikbaar wanneer een avatar is geconfigureerd.
parallel_tool_calls	Of het model meerdere tools parallel kan oproepen.
store	Of de gesprekken met deze agent worden voortgezet. Een enkele, alles-of-niets persistentieschakelaar die standaard staat op false (privacy-veilig: standaard uitgeschakeld). Wanneer true, Foundry het volledige gesprek voortzet — de transcript/gebeurtenistijdlijn en ruwe audio. Wanneer false, wordt er niets voortgezet en ontstaat er geen gesprek. Er is geen aparte audiologging-besturing; audio wordt alleen als onderdeel van deze schakelaar behouden. Latency/prestatie-telemetrie (bijv. time-to-first-audio, inter-token latency, interrupt) is alleen observabiliteit (customer trace / App Insights) en maakt geen deel uit van de onderhoudsinhoud van het gesprek.
structured_inputs	Set gestructureerde invoer die deelnemen aan prompttemplate-vervanging, gerenderd per sessie voordat de live sessie begint.
subagent_config	Optionele configuratie voor zuster-Foundry tekstagenten die deze spraakagent kan raadplegen als achtergrondspecialisten.
tools	De tools die de voice agent kan gebruiken. Ondersteunde tooltypes zijn function (uitgevoerd door de client), mcp, system (service-managed sessiecontroles), en toolbox. Server-side tools zoals web_search, azure_ai_search, en openapi worden geleverd via een toolbox in plaats van direct gedeclareerd.
tool_choice	Hoe het model tools kiest voor gegenereerde reacties. none voorkomt tool-aanroepen, auto laat het model beslissen, required vereist ten minste één tool-aanroep, en een specifieke functie of MCP-tool kan met een object worden geselecteerd. Wordt standaard ingesteld op auto.

Overgenomen eigenschappen

rai_config

Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.

Eigenschapdetails

audio

De audioconfiguratie, inclusief invoer- en uitvoerformaten, spraak, draaidetectie, ruisonderdrukking en transcriptie. Deze waarden zijn sessiestandaarden; een client kan ondersteunde velden overschrijven bij het verbinden.

audio?: VoiceAgentAudioConfig

Waarde van eigenschap

VoiceAgentAudioConfig

avatar

Optionele avatarconfiguratie. Deze waarden zijn sessiestandaardwaarden en kunnen worden overschreven bij het verbinden.

avatar?: VoiceAgentAvatarConfig

Waarde van eigenschap

VoiceAgentAvatarConfig

conversation_engine

De engine die de gespreksafhandeling voor deze spraakagent beheert. Precies één van deze eigenschap en de model-backed configuratie (model_type met model) moet worden verstrekt. Wanneer deze eigenschap wordt gegeven, model_type, model, instructions, , toolsmoeten tool_choice en worden weggelaten, en greeting.tool_choice kan niet , requiredomdat de engine eigenaar is van de conversatielogica. De eerste implementatie ondersteunt een hosted-agent engine.

conversation_engine?: VoiceConversationEngineUnion

Waarde van eigenschap

VoiceConversationEngineUnion

greeting

Optionele sessie-start begroeting. Template-modus spreekt exacte gerenderde tekst; LLM-gegenereerde modus vraagt het sessiemodel om het openingsantwoord te schrijven en kan geconfigureerde tools gebruiken.

greeting?: VoiceAgentGreetingConfigUnion

Waarde van eigenschap

VoiceAgentGreetingConfigUnion

include

Extra velden om in service-output op te nemen.

include?: VoiceAgentSessionIncludeOption[]

Waarde van eigenschap

VoiceAgentSessionIncludeOption[]

instructions

Een systeembericht (of ontwikkelaarsbericht) dat is ingevoegd binnen de context van het model. Ondersteunt sjabloonvervanging via structured_inputs, gerenderd per sessie voordat de live sessie begint.

instructions?: string

Waarde van eigenschap

string

interim_response

Interim-responsinstellingen voor latentie en tool-uitvoering.

interim_response?: VoiceAgentInterimResponseConfigUnion

Waarde van eigenschap

VoiceAgentInterimResponseConfigUnion

kind

De soort discriminator voor een definitie van een stemagent. Altijd voice.

kind: "voice"

Waarde van eigenschap

"voice"

max_output_tokens

Het maximale aantal outputtokens voor één respons.

max_output_tokens?: VoiceAgentMaxOutputTokens

Waarde van eigenschap

VoiceAgentMaxOutputTokens

model

Het model om voor dit middel te gebruiken. Vereist voor model_type een model-ondersteunde stemagent en weggelaten wanneer conversation_engine deze wordt verstrekt. Het model moet realtime of gecascadeerde spraak ondersteunen.

model?: string

Waarde van eigenschap

string

model_type

Hoe het model achter deze voice agent wordt bediend. Vereist voor model een model-ondersteunde stemagent en weggelaten wanneer conversation_engine deze wordt verstrekt. Dit is onafhankelijk van de architectuur (realtime of gecascadeerd), die de service afleidt van het gekozen model.

model_type?: VoiceModelType

Waarde van eigenschap

VoiceModelType

output_modalities

De outputmodaliteiten die de agent produceert. Wordt standaard ingesteld op ["audio"]. animation en avatar zijn beschikbaar wanneer een avatar is geconfigureerd.

output_modalities?: VoiceOutputModality[]

Waarde van eigenschap

VoiceOutputModality[]

parallel_tool_calls

Of het model meerdere tools parallel kan oproepen.

parallel_tool_calls?: boolean

Waarde van eigenschap

boolean

store

Of de gesprekken met deze agent worden voortgezet. Een enkele, alles-of-niets persistentieschakelaar die standaard staat op false (privacy-veilig: standaard uitgeschakeld). Wanneer true, Foundry het volledige gesprek voortzet — de transcript/gebeurtenistijdlijn en ruwe audio. Wanneer false, wordt er niets voortgezet en ontstaat er geen gesprek. Er is geen aparte audiologging-besturing; audio wordt alleen als onderdeel van deze schakelaar behouden. Latency/prestatie-telemetrie (bijv. time-to-first-audio, inter-token latency, interrupt) is alleen observabiliteit (customer trace / App Insights) en maakt geen deel uit van de onderhoudsinhoud van het gesprek.

store?: boolean

Waarde van eigenschap

boolean

structured_inputs

Set gestructureerde invoer die deelnemen aan prompttemplate-vervanging, gerenderd per sessie voordat de live sessie begint.

structured_inputs?: Record<string, StructuredInputDefinition>

Waarde van eigenschap

Record<string, StructuredInputDefinition>

subagent_config

Optionele configuratie voor zuster-Foundry tekstagenten die deze spraakagent kan raadplegen als achtergrondspecialisten.

subagent_config?: VoiceAgentSubagentConfig

Waarde van eigenschap

VoiceAgentSubagentConfig

tools

De tools die de voice agent kan gebruiken. Ondersteunde tooltypes zijn function (uitgevoerd door de client), mcp, system (service-managed sessiecontroles), en toolbox. Server-side tools zoals web_search, azure_ai_search, en openapi worden geleverd via een toolbox in plaats van direct gedeclareerd.

tools?: VoiceAgentToolUnion[]

Waarde van eigenschap

VoiceAgentToolUnion[]

tool_choice

Hoe het model tools kiest voor gegenereerde reacties. none voorkomt tool-aanroepen, auto laat het model beslissen, required vereist ten minste één tool-aanroep, en een specifieke functie of MCP-tool kan met een object worden geselecteerd. Wordt standaard ingesteld op auto.

tool_choice?: VoiceAgentToolChoice

Waarde van eigenschap

VoiceAgentToolChoice

Details van overgenomen eigenschap

rai_config

Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.

rai_config?: RaiConfig

Waarde van eigenschap

RaiConfig

Geërfdvan AgentDefinition.rai_config