realtime/realtime.go (package realtime)
Source : sdks/go/realtime/realtime.go. Retour à l'index de la référence du SDK Go.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe Event
Event est un événement temps réel ; Raw garde la trame complète.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Type (type) | string | oui | Type de l'événement, par exemple transcript.delta ou error. |
Event.Decode
Decode(v any) error
Decode décode la trame complète dans v.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
v | any | oui | Pointeur dans lequel le JSON de la trame complète est décodé. |
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Classe ServerError
ServerError est un événement "error" reçu du serveur.
Champs :
| Nom | Type | Requis | Description |
|---|---|---|---|
Code (code) | string | oui | Code machine de l'erreur envoyé par le serveur. |
Message (message) | string | oui | Message de l'erreur envoyé par le serveur. |
ServerError.Error
Error() string
Error met en forme l'événement en realtime: <code>: <message>.
Cet élément ne prend aucun paramètre.
Retour : string. Le texte de l'erreur avec le code et le message.
Classe Conn
Conn est une connexion temps réel ouverte. Send peut être appelé par plusieurs goroutines ; appeler Recv depuis une seule goroutine.
Conn.AppendAudio
AppendAudio(pcm []byte) error
AppendAudio envoie input_audio.append avec de l'audio PCM encodé en base64.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
pcm | []byte | oui | Octets audio PCM bruts, envoyés encodés en base64 dans le champ audio. |
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Conn.Close
Close() error
Close ferme la connexion.
Cet élément ne prend aucun paramètre.
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Conn.Recv
Recv() (Event, error)
Recv lit l'événement suivant. Un événement "error" est renvoyé avec une *ServerError.
Cet élément ne prend aucun paramètre.
Retour : (Event, error). Un Event : un événement temps réel ; Raw garde la trame complète. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.
Conn.Send
Send(eventType string, fields map[string]any) error
Send écrit un événement : les champs sont fusionnés avec {"type": eventType}.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
eventType | string | oui | Type de l'événement, par exemple session.update ; il remplace une clé type de fields. | |
fields | map[string]any | oui | Autres champs de la trame JSON. |
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Conn.UpdateSession
UpdateSession(session map[string]any) error
UpdateSession envoie session.update.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
session | map[string]any | oui | Réglages de la session, envoyés dans le champ session de l'événement. |
Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.
Erreurs levées : error.
Fonctions
Dial
Dial(ctx context.Context, c *eai.Client, sessionID string, opts ...eai.CallOption) (*Conn, error)
Dial demande un nouveau ws_token à usage unique pour la session, puis ouvre le WebSocket avec ce jeton et les en-têtes d'identifiants, de tenancy, de langue et de trace du client.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
ctx | context.Context | oui | Contexte de l'appel : annulation et échéance. | |
c | *eai.Client | oui | Client eai configuré ; son URL de base, ses identifiants et ses en-têtes sont utilisés. | |
sessionID | string | oui | Identifiant d'une session créée avec Client.Realtime.CreateSession. | |
opts | ...eai.CallOption | non | Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes). |
Retour : (*Conn, error). Une Conn : une connexion temps réel ouverte. Send peut être appelé par plusieurs goroutines ; appeler Recv depuis une seule goroutine. L'error est une erreur typée du SDK, nil en cas de succès.
Erreurs levées : error.
IsServerError
IsServerError(err error) bool
IsServerError signale un événement d'erreur.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
err | error | oui | Erreur renvoyée par Recv. |
Retour : bool. true quand err est ou enveloppe une *ServerError.