VoiceAgentResponseCreateParams interface

Paramètres acceptés par un événement d’agent response.create vocal.

Propriétés

audio

Paramètres audio spécifiques à la réponse.

conversation

Contrôle à quelle conversation la réponse est ajoutée. Prend actuellement en charge auto et none, avec auto comme valeur par défaut. Cette auto valeur signifie que le contenu de la réponse sera ajouté à la conversation par défaut. Réglez cela pour none créer une réponse hors bande qui n’ajoutera pas d’éléments à la conversation par défaut.

input

Les éléments de conversation servent d’entrée de réponse en ligne.

instructions

Les instructions système par défaut (par exemple, message système) sont ajoutées aux appels de modèle. Ce champ permet au client de guider le modèle sur les réponses souhaitées. Le modèle peut être indiqué sur le contenu et le format de réponse (par exemple, « être extrêmement succinct », « agir facilement », « voici des exemples de bonnes réponses ») et sur le comportement audio (par exemple, « parler rapidement », « injecter l’émotion dans votre voix », « rire fréquemment »). Les instructions ne sont pas garanties d’être suivies par le modèle, mais elles fournissent des conseils au modèle sur le comportement souhaité. Notez que le serveur définit les instructions par défaut qui seront utilisées si ce champ n’est pas défini et sont visibles dans l’événement session.created au début de la session.

interim_response

Paramètres de réponse intermédiaire pour cette réponse.

max_output_tokens

Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, incluant les appels d’outils. Fournissez un entier compris entre 1 et 4096 pour limiter les jetons de sortie, ou inf pour les jetons maximum disponibles pour un modèle donné. La valeur par défaut est inf.

metadata

Des paires clé-valeur personnalisées à associer à la réponse.

output_modalities

Modalités que la réponse peut revenir.

parallel_tool_calls

Si le modèle peut appeler plusieurs outils en parallèle. Uniquement supporté par des modèles en temps réel de raisonnement tels que gpt-realtime-2.

pre_generated_assistant_message

Un message d’assistant pré-généré utilisé pour commencer la réponse.

reasoning

Paramètres de raisonnement pour la réponse lors de l’utilisation d’un modèle temps réel capable de raisonner.

tools

Outils disponibles pour le modèle.

tool_choice

Comment le modèle choisit les outils. Fournir un des modes de chaîne ou forcer une fonction spécifique ou un outil MCP.

Détails de la propriété

audio

Paramètres audio spécifiques à la réponse.

audio?: PickPropertiesVoiceAgentAudioConfig

Valeur de propriété

conversation

Contrôle à quelle conversation la réponse est ajoutée. Prend actuellement en charge auto et none, avec auto comme valeur par défaut. Cette auto valeur signifie que le contenu de la réponse sera ajouté à la conversation par défaut. Réglez cela pour none créer une réponse hors bande qui n’ajoutera pas d’éléments à la conversation par défaut.

conversation?: "auto" | "none"

Valeur de propriété

"auto" | "none"

input

Les éléments de conversation servent d’entrée de réponse en ligne.

input?: RealtimeConversationItemUnion[]

Valeur de propriété

instructions

Les instructions système par défaut (par exemple, message système) sont ajoutées aux appels de modèle. Ce champ permet au client de guider le modèle sur les réponses souhaitées. Le modèle peut être indiqué sur le contenu et le format de réponse (par exemple, « être extrêmement succinct », « agir facilement », « voici des exemples de bonnes réponses ») et sur le comportement audio (par exemple, « parler rapidement », « injecter l’émotion dans votre voix », « rire fréquemment »). Les instructions ne sont pas garanties d’être suivies par le modèle, mais elles fournissent des conseils au modèle sur le comportement souhaité. Notez que le serveur définit les instructions par défaut qui seront utilisées si ce champ n’est pas défini et sont visibles dans l’événement session.created au début de la session.

instructions?: string

Valeur de propriété

string

interim_response

Paramètres de réponse intermédiaire pour cette réponse.

interim_response?: VoiceAgentInterimResponseConfigUnion

Valeur de propriété

max_output_tokens

Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, incluant les appels d’outils. Fournissez un entier compris entre 1 et 4096 pour limiter les jetons de sortie, ou inf pour les jetons maximum disponibles pour un modèle donné. La valeur par défaut est inf.

max_output_tokens?: number | "inf"

Valeur de propriété

number | "inf"

metadata

Des paires clé-valeur personnalisées à associer à la réponse.

metadata?: Metadata

Valeur de propriété

output_modalities

Modalités que la réponse peut revenir.

output_modalities?: VoiceOutputModality[]

Valeur de propriété

parallel_tool_calls

Si le modèle peut appeler plusieurs outils en parallèle. Uniquement supporté par des modèles en temps réel de raisonnement tels que gpt-realtime-2.

parallel_tool_calls?: boolean

Valeur de propriété

boolean

pre_generated_assistant_message

Un message d’assistant pré-généré utilisé pour commencer la réponse.

pre_generated_assistant_message?: RealtimeConversationItemUnion

Valeur de propriété

reasoning

Paramètres de raisonnement pour la réponse lors de l’utilisation d’un modèle temps réel capable de raisonner.

reasoning?: RealtimeReasoning

Valeur de propriété

tools

Outils disponibles pour le modèle.

tools?: (MCPTool | RealtimeFunctionTool)[]

Valeur de propriété

tool_choice

Comment le modèle choisit les outils. Fournir un des modes de chaîne ou forcer une fonction spécifique ou un outil MCP.

tool_choice?: ToolChoiceFunction | ToolChoiceMCP | ToolChoiceOptions

Valeur de propriété