VoiceResponse interface

Une réponse vocale persistante représentant un tour d’inférence de modèle au sein d’une conversation. Dans les résultats de liste, la output projection peut être omise ; récupérer la réponse complète (GET .../responses/{response_id}) ou la route des éléments de réponse paginés (GET .../responses/{response_id}/items) pour ses éléments de sortie. created_at / completed_at sont des extensions de commande durables Foundry.

Propriétés

audio

La configuration audio utilisée pour la réponse, y compris la voix et le format audio utilisés pour la sortie.

completed_at

L’horodatage Unix (en secondes) indique la fin de la réponse.

conversation_id

La conversation à laquelle la réponse est ajoutée dépend du champ de l’événement conversationresponse.create . Si auto, la réponse sera ajoutée à la conversation par défaut et la valeur de conversation_id sera un id comme conv_1234. Si none, la réponse ne sera ajoutée à aucune conversation et la valeur de conversation_id sera null. Si les réponses sont déclenchées automatiquement par le VAD, la réponse sera ajoutée à la conversation par défaut

created_at

L’horodatage Unix (en secondes) indique la création de la réponse.

id

L’identifiant unique de la réponse ressemblera à resp_1234.

max_output_tokens

Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, y compris les appels d’outils, qui a été utilisé dans cette réponse.

metadata

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

object

Le type d’objet doit être realtime.response.

output

La liste des éléments générés par la réponse.

output_modalities

L’ensemble des modalités utilisées par le modèle pour répondre, actuellement les seules valeurs possibles sont [\"audio\"], [\"text\"]. La sortie audio inclut toujours une transcription textuelle. Mettre la sortie en mode text désactivera la sortie audio du modèle.

status

Le statut final de la réponse (completed, cancelled, failed, ou incomplete, in_progress).

status_details

Détails supplémentaires sur l’état d’avancement.

temperature

La température d’échantillonnage utilisée pour la réponse.

usage

Les statistiques d’utilisation pour la Réponse correspondent à la facturation. Une session API en temps réel maintiendra un contexte de conversation et ajoutera de nouveaux éléments à la conversation, ainsi, la sortie des tours précédents (jetons texte et audio) deviendra l’entrée pour les tours suivants.

Détails de la propriété

audio

La configuration audio utilisée pour la réponse, y compris la voix et le format audio utilisés pour la sortie.

audio?: VoiceResponseAudio

Valeur de propriété

completed_at

L’horodatage Unix (en secondes) indique la fin de la réponse.

completed_at?: Date

Valeur de propriété

Date

conversation_id

La conversation à laquelle la réponse est ajoutée dépend du champ de l’événement conversationresponse.create . Si auto, la réponse sera ajoutée à la conversation par défaut et la valeur de conversation_id sera un id comme conv_1234. Si none, la réponse ne sera ajoutée à aucune conversation et la valeur de conversation_id sera null. Si les réponses sont déclenchées automatiquement par le VAD, la réponse sera ajoutée à la conversation par défaut

conversation_id?: string

Valeur de propriété

string

created_at

L’horodatage Unix (en secondes) indique la création de la réponse.

created_at?: Date

Valeur de propriété

Date

id

L’identifiant unique de la réponse ressemblera à resp_1234.

id?: string

Valeur de propriété

string

max_output_tokens

Nombre maximal de jetons de sortie pour une réponse d’un seul assistant, y compris les appels d’outils, qui a été utilisé dans cette réponse.

max_output_tokens?: number | "inf"

Valeur de propriété

number | "inf"

metadata

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

metadata?: Metadata

Valeur de propriété

object

Le type d’objet doit être realtime.response.

object?: "realtime.response"

Valeur de propriété

"realtime.response"

output

La liste des éléments générés par la réponse.

output?: RealtimeConversationItemUnion[]

Valeur de propriété

output_modalities

L’ensemble des modalités utilisées par le modèle pour répondre, actuellement les seules valeurs possibles sont [\"audio\"], [\"text\"]. La sortie audio inclut toujours une transcription textuelle. Mettre la sortie en mode text désactivera la sortie audio du modèle.

output_modalities?: ("text" | "audio")[]

Valeur de propriété

("text" | "audio")[]

status

Le statut final de la réponse (completed, cancelled, failed, ou incomplete, in_progress).

status?: "failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

Valeur de propriété

"failed" | "in_progress" | "cancelled" | "completed" | "incomplete"

status_details

Détails supplémentaires sur l’état d’avancement.

status_details?: RealtimeResponseStatusDetails

Valeur de propriété

temperature

La température d’échantillonnage utilisée pour la réponse.

temperature?: number

Valeur de propriété

number

usage

Les statistiques d’utilisation pour la Réponse correspondent à la facturation. Une session API en temps réel maintiendra un contexte de conversation et ajoutera de nouveaux éléments à la conversation, ainsi, la sortie des tours précédents (jetons texte et audio) deviendra l’entrée pour les tours suivants.

usage?: RealtimeResponseUsage

Valeur de propriété