VoiceAgentResponseCreateParams interface

Pacote:

@azure/ai-projects

Parâmetros aceites por um evento de voice-agent response.create .

Propriedades

audio	Definições de áudio específicas para a resposta.
conversation	Controla a que conversa a resposta é adicionada. Atualmente suporta auto e none, com auto o valor predefinido. O auto valor significa que o conteúdo da resposta será adicionado à conversa padrão. Defina isto para none criar uma resposta fora de banda que não adicione itens à conversa padrão.
input	Itens de conversa usados como entrada de resposta em linha.
instructions	As instruções padrão do sistema (ou seja, a mensagem do sistema) são adicionadas antes das chamadas de modelo. Este campo permite ao cliente orientar o modelo sobre as respostas desejadas. O modelo pode ser instruído sobre o conteúdo e formato da resposta (por exemplo, "seja extremamente sucinto", "aja amigável", "aqui estão exemplos de boas respostas") e sobre o comportamento de áudio (por exemplo, "fale rapidamente", "injete emoção em sua voz", "ria com frequência"). Não é garantido que as instruções sejam seguidas pelo modelo, mas fornecem orientação ao modelo sobre o comportamento desejado. Note que o servidor define instruções por defeito que serão usadas se este campo não estiver definido e que são visíveis no session.created evento no início da sessão.
interim_response	Definições de resposta intermédia para esta resposta.
max_output_tokens	Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta. Forneça um inteiro entre 1 e 4096 para limitar os tokens de saída ou inf para o máximo de tokens disponíveis para um determinado modelo. O valor padrão é inf.
metadata	Pares chave-valor personalizados para associar à resposta.
output_modalities	Modalidades que a resposta pode retornar.
parallel_tool_calls	Se o modelo pode chamar múltiplas ferramentas em paralelo. Apenas suportado por modelos de raciocínio em tempo real, como gpt-realtime-2.
pre_generated_assistant_message	Uma mensagem de assistente pré-gerada era usada para iniciar a resposta.
reasoning	Definições de raciocínio para a resposta ao usar um modelo de tempo real com capacidade de raciocínio.
tools	Ferramentas disponíveis para o modelo.
tool_choice	Como o modelo escolhe as ferramentas. Forneça um dos modos da cadeia ou force uma função/ferramenta MCP específica.

Detalhes de Propriedade

audio

Definições de áudio específicas para a resposta.

audio?: PickPropertiesVoiceAgentAudioConfig

Valor de Propriedade

PickPropertiesVoiceAgentAudioConfig

conversation

Controla a que conversa a resposta é adicionada. Atualmente suporta auto e none, com auto o valor predefinido. O auto valor significa que o conteúdo da resposta será adicionado à conversa padrão. Defina isto para none criar uma resposta fora de banda que não adicione itens à conversa padrão.

conversation?: "auto" | "none"

Valor de Propriedade

"auto" | "none"

input

Itens de conversa usados como entrada de resposta em linha.

input?: RealtimeConversationItemUnion[]

Valor de Propriedade

RealtimeConversationItemUnion[]

instructions

As instruções padrão do sistema (ou seja, a mensagem do sistema) são adicionadas antes das chamadas de modelo. Este campo permite ao cliente orientar o modelo sobre as respostas desejadas. O modelo pode ser instruído sobre o conteúdo e formato da resposta (por exemplo, "seja extremamente sucinto", "aja amigável", "aqui estão exemplos de boas respostas") e sobre o comportamento de áudio (por exemplo, "fale rapidamente", "injete emoção em sua voz", "ria com frequência"). Não é garantido que as instruções sejam seguidas pelo modelo, mas fornecem orientação ao modelo sobre o comportamento desejado. Note que o servidor define instruções por defeito que serão usadas se este campo não estiver definido e que são visíveis no session.created evento no início da sessão.

instructions?: string

Valor de Propriedade

string

interim_response

Definições de resposta intermédia para esta resposta.

interim_response?: VoiceAgentInterimResponseConfigUnion

Valor de Propriedade

VoiceAgentInterimResponseConfigUnion

max_output_tokens

Número máximo de tokens de saída para uma resposta de um único assistente, incluindo chamadas de ferramenta. Forneça um inteiro entre 1 e 4096 para limitar os tokens de saída ou inf para o máximo de tokens disponíveis para um determinado modelo. O valor padrão é inf.

max_output_tokens?: number | "inf"

Valor de Propriedade

number | "inf"

metadata

Pares chave-valor personalizados para associar à resposta.

metadata?: Metadata

Valor de Propriedade

Metadata

output_modalities

Modalidades que a resposta pode retornar.

output_modalities?: VoiceOutputModality[]

Valor de Propriedade

VoiceOutputModality[]

parallel_tool_calls

Se o modelo pode chamar múltiplas ferramentas em paralelo. Apenas suportado por modelos de raciocínio em tempo real, como gpt-realtime-2.

parallel_tool_calls?: boolean

Valor de Propriedade

boolean

pre_generated_assistant_message

Uma mensagem de assistente pré-gerada era usada para iniciar a resposta.

pre_generated_assistant_message?: RealtimeConversationItemUnion

Valor de Propriedade

RealtimeConversationItemUnion

reasoning

Definições de raciocínio para a resposta ao usar um modelo de tempo real com capacidade de raciocínio.

reasoning?: RealtimeReasoning

Valor de Propriedade

RealtimeReasoning

tools

Ferramentas disponíveis para o modelo.

tools?: (MCPTool | RealtimeFunctionTool)[]

Valor de Propriedade

(MCPTool | RealtimeFunctionTool)[]

tool_choice

Como o modelo escolhe as ferramentas. Forneça um dos modos da cadeia ou force uma função/ferramenta MCP específica.

tool_choice?: ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions

Valor de Propriedade

ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions