VoiceAgentRealtimeResponseBase interface
Propriétés partagées par des réponses en temps réel renvoyées par le service d’agent vocal.
Propriétés
| conversation_id | La conversation à laquelle la réponse est ajoutée dépend du champ de l’événement |
| id | L’identifiant unique de la réponse ressemblera à |
| 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 |
| output_modalities | L’ensemble des modalités utilisées par le modèle pour répondre, actuellement les seules valeurs possibles sont |
| status | Le statut final de la réponse ( |
| status_details | Détails supplémentaires sur l’état d’avancement. |
| 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é
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
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_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é
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