> For the complete documentation index, see [llms.txt](https://docs.dydu.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dydu.ai/developpeurs/reference-api/champ-de-recherche.md).

# Champ de recherche

Le service du champ de recherche propose des connaissances pendant que l'utilisateur tape sa question.

## Envoyer une requête

* **Adresse** : `https://<serveur>/servlet/chatHttp`, en remplaçant `<serveur>` par l'adresse de votre plateforme.
* **Méthode** : `GET` ou `POST`. La requête JSON est envoyée dans le paramètre `data`, ou dans le corps de la requête.
* **Encodage** : les valeurs des paramètres doivent être encodées en base64, sauf `solutionUsed`. Les valeurs de la réponse sont aussi encodées en base64.

La requête est un objet JSON qui contient :

* `type` : le type de requête, « fieldboxproactive » pour obtenir des suggestions pendant la saisie ;
* `parameters` : les paramètres de la recherche (voir ci-dessous) ;
* `callback` (facultatif) : le nom d'une fonction JavaScript, pour recevoir la réponse au format JSONP.

## Paramètres

<table><thead><tr><th width="177">Paramètre</th><th width="98">Obligatoire</th><th>Description</th></tr></thead><tbody><tr><td><code>botId</code></td><td>Oui</td><td>Identifiant du bot. Il est affiché sur la page <strong>Préférences > Api > Accès aux APIs</strong>.</td></tr><tr><td><code>userInput</code></td><td>Oui</td><td>Texte saisi par l'utilisateur.</td></tr><tr><td><code>language</code></td><td>Oui</td><td>Langue de la recherche, en anglais : « French », « English »…</td></tr><tr><td><code>space</code></td><td>Non</td><td>Espace de consultation. Pour n'utiliser aucun espace en particulier, indiquez « Defaut » (valeur par défaut).</td></tr><tr><td><code>contextId</code></td><td>Non</td><td>Identifiant de la recherche. La première réponse du service le contient : renvoyez-le ensuite pour regrouper toutes les requêtes d'une même recherche. Lorsqu'il n'est pas utilisé pendant 10 minutes, la recherche est archivée et l'identifiant n'est plus valable. Si vous envoyez un identifiant invalide ou expiré, le serveur en crée un nouveau.</td></tr><tr><td><code>maxAnswerNumber</code></td><td>Non</td><td>Nombre maximum de suggestions (5 par défaut).</td></tr><tr><td><code>tags</code></td><td>Non</td><td>Thématiques dans lesquelles chercher. Voir <a href="#limiter-la-recherche-a-des-thematiques">Limiter la recherche à des thématiques</a>.</td></tr><tr><td><code>alreadyCame</code></td><td>Non</td><td><code>true</code> si l'utilisateur est déjà venu, <code>false</code> (par défaut) sinon.</td></tr><tr><td><code>clientId</code></td><td>Non</td><td>Identifiant de l'utilisateur. Sans ce paramètre, la recherche est anonyme. Dans le BMS, il n'est affiché qu'aux administrateurs.</td></tr><tr><td><code>userUrl</code></td><td>Non</td><td>URL de la page depuis laquelle la recherche est effectuée.</td></tr><tr><td><code>browser</code></td><td>Non</td><td>Navigateur de l'utilisateur.</td></tr><tr><td><code>os</code></td><td>Non</td><td>Système d'exploitation de l'utilisateur.</td></tr><tr><td><code>qualificationMode</code></td><td>Non</td><td><code>true</code> : mode qualification (recette). Les connaissances publiées et validées sont utilisables et les recherches ne sont pas comptabilisées dans les statistiques. <code>false</code> (par défaut) : seules les connaissances publiées sont utilisables et les recherches sont comptabilisées.</td></tr><tr><td><code>solutionUsed</code></td><td>Non</td><td>Solution utilisée : « FIELDBOX » pour le champ de recherche. Cette valeur peut être envoyée sans encodage.</td></tr></tbody></table>

### Limiter la recherche à des thématiques

Le paramètre `tags` est une liste. Pour chaque thématique, indiquez :

* `path` : le chemin de la thématique, encodé en base64 ;
* `useChildren` : `true` pour inclure les sous-thématiques, `false` sinon.

```
"tags": [
  { "path": "cm9vdC90YWcxCg==", "useChildren": true }
]
```

## Exemple

Requête, avec les valeurs encodées en base64 (« f0de8c15-af21-467f-8cec-1494ee85ec87 », « English », « how », « Common ») :

```
{
  "type": "fieldboxproactive",
  "parameters": {
    "solutionUsed": "FIELDBOX",
    "botId": "ZjBkZThjMTUtYWYyMS00NjdmLThjZWMtMTQ5NGVlODVlYzg3",
    "language": "RW5nbGlzaA==",
    "userInput": "aG93",
    "space": "Q29tbW9u"
  }
}
```

Réponse :

```
{
  "type": "fieldboxproactive",
  "values": {
    "botId": "ZjBkZThjMTUtYWYyMS00NjdmLThjZWMtMTQ5NGVlODVlYzg3",
    "sourceInput": "aG93",
    "contextId": "ZWQ1OTM3NWItN2MyYy00NDRmLTkzZDQtMzBhNjFiNGUyOGE5",
    "suggestions": []
  }
}
```

`suggestions` contient la liste des connaissances proposées, encodées en base64.

{% hint style="info" %}
Le type de requête « fieldboxtalk » renvoie directement les réponses des connaissances trouvées. Il accepte les mêmes paramètres, ainsi que `maxAnswerThresHold` (10 par défaut) à la place de `maxAnswerNumber`.
{% endhint %}
