GenerateVoiceAgentRequest Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v3.0.0-beta.3

Source:

GenerateVoiceAgentRequest.cs

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 class GenerateVoiceAgentRequest : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.GenerateVoiceAgentRequest>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.GenerateVoiceAgentRequest>

type GenerateVoiceAgentRequest = class
    interface IJsonModel<GenerateVoiceAgentRequest>
    interface IPersistableModel<GenerateVoiceAgentRequest>

Public Class GenerateVoiceAgentRequest
Implements IJsonModel(Of GenerateVoiceAgentRequest), IPersistableModel(Of GenerateVoiceAgentRequest)

Inheritance

Object

GenerateVoiceAgentRequest

Implements

IJsonModel<GenerateVoiceAgentRequest> IPersistableModel<GenerateVoiceAgentRequest> IPersistableModel<T>

Constructors

Name	Description
GenerateVoiceAgentRequest(String)	Initializes a new instance of GenerateVoiceAgentRequest.

Properties

Name	Description
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.
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.
ModelType	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).
UseCase	An optional authoring use case. An empty string is accepted.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<GenerateVoiceAgentRequest>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GenerateVoiceAgentRequest>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GenerateVoiceAgentRequest>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GenerateVoiceAgentRequest>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GenerateVoiceAgentRequest>.Write(ModelReaderWriterOptions)