Schemas

Download schema

ConversationIn

avatar_id

string | null · maxLength: 64

Avatar du déploiement (facultatif : celui du déploiement par défaut).

lang

string | null · maxLength: 8

Langue souhaitée, parmi celles du déploiement.

resume

string | null · maxLength: 64

Identifiant d'une conversation à reprendre (moins de 30 min d'inactivité).

MessageIn

message

string · minLength: 1 · maxLength: 1000 · required

Question du visiteur (tapée ou transcrite).

lang

string | null · maxLength: 8

Accepté, sans effet en v1 : l'avatar répond dans la langue de la question, détectée à chaque message.

mode

string · enum

« voice » : réponse rédigée pour être dite à voix haute.

Enum values:

text

voice

Default: text

page

string | null · maxLength: 500

Page consultée par le visiteur (accueil et réponses selon la page).

SpeechIn

text

string · minLength: 1 · maxLength: 2000 · required

Texte à dire (2 000 caractères au plus ; liens et Markdown retirés).

lang

string | null · maxLength: 8

Langue du texte : choisit la voix déclarée par le client pour cette langue, si l'avatar du déploiement est celui du client ; sinon, la voix de l'avatar.

turn

integer | null · min: 0

Numéro du tour (champ turn de l'événement done de /messages) : tous les morceaux d'une même réponse portent le même numéro et ne comptent qu'une fois. Absent : le dernier tour de la conversation (0 avant la première question, ex. l'accueil). Un tour reçoit au plus 1 500 caractères de voix, tous morceaux compris.

Erreur

object · required

QuestionOrale

audio

string · binary · required

Son de la question : webm, ogg, mp4, m4a, wav ou mp3 ; 5 Mo au plus

lang

string | null

Langue parlée (indice pour la transcription)