VoiceAgentResponseCreateParams interface

Parâmetros aceitos por um evento de agente response.create de voz.

Propriedades

audio

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

conversation

Controle a qual conversa a resposta é adicionada. Atualmente suporta auto e none, com auto o valor padrão. O auto valor significa que o conteúdo da resposta será adicionado à conversa padrão. Configure isso para none criar uma resposta fora de banda que não adicionará itens à conversa padrão.

input

Itens de conversa usados como entrada de resposta inline.

instructions

As instruções padrão do sistema (ou seja, mensagem do sistema) são anexadas a chamadas de modelo. Esse campo permite que o cliente guie o modelo sobre as respostas desejadas. O modelo pode ser instruído sobre o conteúdo e o formato da resposta( por exemplo, "ser extremamente sucinto", "agir amigável", "aqui estão exemplos de boas respostas") e sobre o comportamento de áudio (por exemplo, "falar rapidamente", "injetar emoção em sua voz", "rir com frequência"). Não há garantia de que as instruções sejam seguidas pelo modelo, mas fornecem diretrizes para o modelo sobre o comportamento desejado. Observe que o servidor define instruções padrão que serão usadas se esse campo não estiver definido e estiverem visíveis no session.created evento no início da sessão.

interim_response

Configurações de resposta intermediária para essa resposta.

max_output_tokens

Número máximo de tokens de saída para uma resposta de assistente único, 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. Usa inf como padrão.

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

Configuraçõ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 de string ou force uma função/ferramenta MCP específica.

Detalhes da propriedade

audio

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

audio?: PickPropertiesVoiceAgentAudioConfig

Valor da propriedade

conversation

Controle a qual conversa a resposta é adicionada. Atualmente suporta auto e none, com auto o valor padrão. O auto valor significa que o conteúdo da resposta será adicionado à conversa padrão. Configure isso para none criar uma resposta fora de banda que não adicionará itens à conversa padrão.

conversation?: "auto" | "none"

Valor da propriedade

"auto" | "none"

input

Itens de conversa usados como entrada de resposta inline.

input?: RealtimeConversationItemUnion[]

Valor da propriedade

instructions

As instruções padrão do sistema (ou seja, mensagem do sistema) são anexadas a chamadas de modelo. Esse campo permite que o cliente guie o modelo sobre as respostas desejadas. O modelo pode ser instruído sobre o conteúdo e o formato da resposta( por exemplo, "ser extremamente sucinto", "agir amigável", "aqui estão exemplos de boas respostas") e sobre o comportamento de áudio (por exemplo, "falar rapidamente", "injetar emoção em sua voz", "rir com frequência"). Não há garantia de que as instruções sejam seguidas pelo modelo, mas fornecem diretrizes para o modelo sobre o comportamento desejado. Observe que o servidor define instruções padrão que serão usadas se esse campo não estiver definido e estiverem visíveis no session.created evento no início da sessão.

instructions?: string

Valor da propriedade

string

interim_response

Configurações de resposta intermediária para essa resposta.

interim_response?: VoiceAgentInterimResponseConfigUnion

Valor da propriedade

max_output_tokens

Número máximo de tokens de saída para uma resposta de assistente único, 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. Usa inf como padrão.

max_output_tokens?: number | "inf"

Valor da propriedade

number | "inf"

metadata

Pares chave-valor personalizados para associar à resposta.

metadata?: Metadata

Valor da propriedade

output_modalities

Modalidades que a resposta pode retornar.

output_modalities?: VoiceOutputModality[]

Valor da propriedade

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 da propriedade

boolean

pre_generated_assistant_message

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

pre_generated_assistant_message?: RealtimeConversationItemUnion

Valor da propriedade

reasoning

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

reasoning?: RealtimeReasoning

Valor da propriedade

tools

Ferramentas disponíveis para o modelo.

tools?: (MCPTool | RealtimeFunctionTool)[]

Valor da propriedade

tool_choice

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

tool_choice?: ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions

Valor da propriedade