Aller au contenu principal

Champ de recherche

Paramètres

Les paramètres du service champ de recherche sont les suivants :

Paramètres
contextIdID du dialogue
Le retour du service web contiendra, entre autres, la valeur qu'il faudra par la suite donner à ce champ afin de regrouper toutes les requêtes au sein d'une même recherche. Une requête fait partie d'une recherche seulement si elles ont le même contextId.
Côté serveur, lorsque l'identifiant de contexte est inutilisé pendant 10 minutes, la recherche est archivée et cet identifiant est révoqué.
Si un identifiant de contexte invalide ou révoqué est passé au service web, le serveur n'en tiendra pas compte et générera un nouvel identifiant de contexte valide.
botIDID du bot (Identication du Bot)
L'ID du chatbot peut être récupéré dans Préférences > APIS > Accès aux API.
userlnputInput de l'utilisateur
Ce paramètre contient la question de l'internaute.
spaceEspace de consultation
L'espace de consultation à utiliser peut être envoyé au champs de recherche grâce à ce paramètre. Pour ne pas utiliser d'espace de consultation en particulier, la valeur de ce paramètre doit être Défaut.
languageCode ISO de la langue (fr, en, nl)
Le paramètre language est utile surtout lorsque le bot est multilingue. Le passage de ce paramètre indique quelle langue le bot utilise par défaut.
alreadycameInformation si l'utilisateur est déjà venu
Ce paramètre est utilisé pour indiquer si l'utilisateur a déjà visité. La valeur true indique que l'utilisateur est déjà venu. La valeur false indique que l'utilisateur n'est jamais venu.
clientIdIdenfication de l'internaute
Si ce paramètre n'est pas renseigné, le dialogue sera anonyme. Si ce paramètre est renseigné, ce qui peut être effectué si le champ de recherche est utilisé depuis un espace connecté sur le site, alors cet identifiant sera associé à la recherche.
Dans le back office, dans la page de lecture des requêtes, le nom de l'utilisateur ne sera cependant affiché qu'aux profils administrateurs.
userUrlURL actuelle de l'utilisateur
Ce paramètre permet d'indiquer à partir de quelle URL la recherche est effectuée.
browserNavigateur
Ce paramètre permet d'indiquer quel navigateur est utilisé par l'utilisateur.
qualificationModeMode qualification
Ce paramètre permet d'indiquer si les recherches effectuées sont dans un mode de qualification (ou recette). En positionnant ce paramètre à true, les connaissances qui sont à l'état publié ET validé sont utilisables. D'autre part, les conversations ne sont pas comptabilisées dans les statistiques.
En positionnant ce paramètre à false, seules les connaissances qui sont à l'état publié sont utilisables.
Les recherches sont comptabilisées dans les statistiques. La valeur par défaut de ce paramètre est false.
solutionUsedSolution utilisée
Ce paramètre indique le type de solution utilisée : assistant, livechat, etc.
tag (ou tagID)Thématique
Ce paramètre est utilisé pour inclure une thématique. Pour insérer la valeur d'une thématique, vous pouvez inscrire son nom ou son tagID.
Pour récupérer le tagID d'une thématique : clic droit > inspecter sur votre sous-thématique. Dès lors, récupérez le code suivant (exemple) :
div id="tag-6671"
Dans cet exemple, le tagID est 6671.
maxAnswerNumberNombre maximum de réponses à afficher
Correspond au nombre maximum de réponses à afficher.

Exemple de requête

Requête (entrée) :

Paramètres obligatoiresParamètres optionnels
- botID- alreadyCame
- space- clientId
- language- browser
- userlnput- qualificationMode
- solutionUsed
- userUrl
- maxAnswerNumber
{
"callback": "jsonCallBack",
"type": "fieldboxproactive",
"parameters": {
"solutionUsed": "fieldbox",
"botId": "f0de8c15-af21-467f-8cec-1494ee85ec87",
"language": "en",
"userInput": "how",
"space": "Common"
}
}

Résultat (sortie) :

{
"type": "fieldboxproactive",
"values": {
"sourceInput": "how",
"contextId": "ed59375b-7c2c-444f-93d4-30a61b4e28a9",
"suggestions": []
}
}