GenerateVoiceAgentRequest interface

Package:

@azure/ai-projects

The inputs for generating a voice agent. Only kind and name are always required. The authoring service expands these inputs into a full, editable VoiceAgentDefinition, which is then created through POST /agents. The generated instructions and audio/voice settings are stored as separate fields on the resulting agent definition, so the caller can edit or override any of them afterward via standard agent versioning.

Properties

description	An optional agent description. The authoring service resolves its fallback when omitted.
draft	(Preview) When true, the generated voice agent is created as a draft — an editable, unpublished version the caller can review and refine before publishing it via the standard create/version path. The service defaults to false if a value is not specified by the caller, in which case the agent is created and published normally.
goal	An optional natural-language description of what the agent should do. When supplied, it seeds the generated instructions.
kind	The agent kind. Always voice.
model	Optional model identifier. Required when model_type is self_deployed; optional when model_type is managed or omitted. The service never invents a customer deployment name.
model_type	Optional inference mode. When omitted, the authoring service uses managed. When supplied, use managed or self_deployed.
name	The unique name for the agent to create. Must be a non-empty DNS-like agent name.
tools	Optional tools carried through verbatim onto the generated agent (see VoiceAgentTool).
use_case	An optional authoring use case. An empty string is accepted.

Property Details

description

An optional agent description. The authoring service resolves its fallback when omitted.

description?: string

Property Value

string

draft

(Preview) When true, the generated voice agent is created as a draft — an editable, unpublished version the caller can review and refine before publishing it via the standard create/version path. The service defaults to false if a value is not specified by the caller, in which case the agent is created and published normally.

draft?: boolean

Property Value

boolean

goal

An optional natural-language description of what the agent should do. When supplied, it seeds the generated instructions.

goal?: string

Property Value

string

kind

The agent kind. Always voice.

kind: "voice"

Property Value

"voice"

model

Optional model identifier. Required when model_type is self_deployed; optional when model_type is managed or omitted. The service never invents a customer deployment name.

model?: string

Property Value

string

model_type

Optional inference mode. When omitted, the authoring service uses managed. When supplied, use managed or self_deployed.

model_type?: VoiceModelType

Property Value

VoiceModelType

name

The unique name for the agent to create. Must be a non-empty DNS-like agent name.

name: string

Property Value

string

tools

Optional tools carried through verbatim onto the generated agent (see VoiceAgentTool).

tools?: VoiceAgentToolUnion[]

Property Value

VoiceAgentToolUnion[]

use_case

An optional authoring use case. An empty string is accepted.

use_case?: string

Property Value

string