ProjectsAgentsModelFactory.GenerateVoiceAgentRequest Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public static Azure.AI.Projects.Agents.GenerateVoiceAgentRequest GenerateVoiceAgentRequest(string name = default, Azure.AI.Projects.Agents.VoiceModelType? modelType = default, string model = default, string useCase = default, string goal = default, string description = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.VoiceAgentTool> tools = default, bool? draft = default);static member GenerateVoiceAgentRequest : string * Nullable<Azure.AI.Projects.Agents.VoiceModelType> * string * string * string * string * seq<Azure.AI.Projects.Agents.VoiceAgentTool> * Nullable<bool> -> Azure.AI.Projects.Agents.GenerateVoiceAgentRequestPublic Shared Function GenerateVoiceAgentRequest (Optional name As String = Nothing, Optional modelType As Nullable(Of VoiceModelType) = Nothing, Optional model As String = Nothing, Optional useCase As String = Nothing, Optional goal As String = Nothing, Optional description As String = Nothing, Optional tools As IEnumerable(Of VoiceAgentTool) = Nothing, Optional draft As Nullable(Of Boolean) = Nothing) As GenerateVoiceAgentRequestParameters
- name
- String
The unique name for the agent to create. Must be a non-empty DNS-like agent name.
- modelType
- Nullable<VoiceModelType>
Optional inference mode. When omitted, the authoring service uses managed. When supplied, use managed or self_deployed.
- model
- String
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.
- useCase
- String
An optional authoring use case. An empty string is accepted.
- goal
- String
An optional natural-language description of what the agent should do. When supplied, it seeds the generated instructions.
- description
- String
An optional agent description. The authoring service resolves its fallback when omitted.
- tools
- IEnumerable<VoiceAgentTool>
Optional tools carried through verbatim onto the generated agent (see VoiceAgentTool).
(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.
Returns
A new GenerateVoiceAgentRequest instance for mocking.
