Passer au contenu principal
POST
/
v1
/
next-questions
curl --request POST \ --url https://api.zelinqa.ai/v1/next-questions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data @- <<EOF { "session_id": "conv-7f3a1c", "conversation_history": [ { "role": "assistant", "content": "Bonjour ! Parlez-moi de l'espace que vous souhaitez aménager." }, { "role": "user", "content": "Je cherche une table de salle à manger d'extérieur pour ma terrasse." } ], "answered_question_ids": [] } EOF
{ "next_question": { "external_id": "q_budget_range", "text": "Quelle fourchette de budget aviez-vous en tête pour la table ?" }, "exhausted": false, "nbq_version": "0.9.0-beta.1", "request_id": "req_3b9f0a1c2d4e6f80" }

Autorisations

Authorization
string
header
requis

Transmettez votre clé API NBQ dans l'en-tête Authorization : Bearer nbq_live_xxx

Corps

application/json
session_id
string
requis

Un identifiant stable pour la conversation. Réutilisez la même valeur pour chaque appel au sein d'une conversation — c'est ainsi que l'utilisation est comptabilisée.

Required string length: 1 - 128
Exemple:

"conv-7f3a1c"

conversation_history
object[]

L'intégralité de la conversation jusqu'à présent, sous forme de liste ordonnée de messages. Obligatoire si context n'est pas fourni. Le dernier message doit avoir role: "user".

Maximum array length: 50
context
string

Un résumé en texte libre de la conversation jusqu'à présent. Obligatoire si conversation_history n'est pas fourni. Incluez les faits recueillis, le profil utilisateur et la dernière intention. Maximum 8000 caractères.

Maximum string length: 8000
Exemple:

"Le visiteur souhaite une table d'extérieur pour une terrasse exposée plein sud. Préfère le métal contemporain. Budget non encore abordé."

answered_question_ids
string[]

Les valeurs external_id des questions déjà posées et auxquelles il a été répondu. NBQ les exclut pour ne jamais répéter une question.

Maximum array length: 200
Exemple:
["q_budget_range", "q_seating_capacity"]

Réponse

Prochaine question retournée

next_question
object

La prochaine question recommandée, ou null quand exhausted est true.

exhausted
boolean

true quand toutes les questions éligibles ont été posées. Traitez cela comme le signal pour terminer le flux de questions.

Exemple:

false

nbq_version
string

Identifiant de version de la configuration NBQ Studio active. À inclure dans les journaux et les demandes de support.

Exemple:

"0.9.0-beta.1"

request_id
string

Identifiant unique de cet appel API. À inclure dans toute demande de support.

Exemple:

"req_3b9f0a1c2d4e6f80"