Jamdesk Documentation logo

Endpoint de recherche

POSThttps://jamdesk.com/docs/_api/search

Effectue une recherche vectorielle sémantique dans la documentation de votre projet et retourne les pages correspondantes classées par score de pertinence.

Les requêtes sont encodées dans le même espace vectoriel utilisé pour indexer votre documentation, de sorte que la recherche comprend l'intention — pas seulement les mots-clés. Posez une question complète en langage naturel pour de meilleurs résultats.

Forme de la réponse : un tableau de résultats (titre, section, slug, extrait de contenu, URL, score), ainsi que la requête originale, le nombre total de résultats et la durée de recherche. Le champ extrait est limité à 500 caractères et est directement utilisable comme contexte LLM.

Latence typique : 50 à 200 ms pour les requêtes sur des projets de moins de 10 000 pages. La latence croît de manière sous-linéaire avec la taille de l'index.

Loading code example
Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

querystringrequired

Requête de recherche en langage naturel.

Length: <= 500
limitinteger

Nombre maximum de résultats à retourner.

Required range: x >= 1, x <= 20
Default: 5
languagestring

Code de langue BCP-47 (par ex. `en`, `es`, `pt-BR` ; les tags à 3 segments comme `zh-Hant-HK` ne sont pas pris en charge). Filtre les résultats sur cette langue dans les projets multilingues ; ignoré dans les projets monolingues. Par défaut `en`.

Pattern: ^[a-zA-Z]{2,3}([-_][a-zA-Z]{2,4})?$
Default: "en"

Response

application/json

Résultats de recherche

resultsarray<object>
results.titlestring

Titre de la page.

results.sectionstring

En-tête de section dans la page (le cas échéant).

results.slugstring

Chemin URL vers la page.

results.contentstring

Extrait de contenu (500 caractères max).

results.urlstring<uri>

URL complète vers la page.

results.scorenumber<float>

Score de pertinence (similarité cosinus, 0.0–1.0). Plus la valeur est élevée, meilleur est le résultat.

Required range: x >= 0, x <= 1
querystring

La requête qui a été recherchée.

languagestring

Langue résolue. Reprend la valeur envoyée, avec `en` par défaut si la requête a omis le champ.

totalinteger

Nombre de résultats retournés.

durationMsinteger

Temps d'exécution de la recherche côté serveur en millisecondes (hors aller-retour réseau).