Aller au contenu principal

Référence de l'API

L'API J'apprends fournit des points de terminaison pour interroger l'index vectoriel.

Points de terminaison​

POST /query​

Accepte une requête via une requête POST avec un corps JSON.

Corps de la requête :

{
  "query_text": "string",
  "num_neighbors": 10
}

Corps de la réponse :

{
  "matches": [
    {
      "id": "string",
      "distance": 0,
      "question": "string",
      "answer": "string"
    }
  ]
}

GET /query​

Accepte une requête via une requête GET avec des paramètres d'URL.

Paramètres de la requête :

  • query_text (string, requis) : Le texte à rechercher.
  • num_neighbors (integer, optionnel, par défaut : 10) : Le nombre de voisins à retourner.

Exemple :

/query?query_text=Comment%20dit-on%20bonjour%20en%20fran%C3%A7ais%3F&num_neighbors=5

Corps de la réponse :

Le même que pour la requête POST.