Jamdesk Documentation logo

Endpoint de búsqueda

POSThttps://{project}.jamdesk.app/_api/search

Realiza una búsqueda semántica vectorial en la documentación de tu proyecto y devuelve las páginas coincidentes ordenadas por puntuación de relevancia.

Las consultas se transforman en el mismo espacio vectorial utilizado para indexar tu documentación, de modo que la búsqueda entiende la intención — no solo las palabras clave. Formula una pregunta completa en lenguaje natural para obtener los mejores resultados.

Estructura de la respuesta: un array de resultados (título, sección, slug, fragmento de contenido, URL, puntuación), junto con la consulta original, el recuento total y la duración de la búsqueda. El campo de fragmento está limitado a 500 caracteres y es directamente utilizable como contexto para un LLM.

Latencia típica: 50-200 ms para consultas en proyectos con menos de 10 000 páginas. La latencia escala de forma sublineal con el tamaño del índice.

Authorizations

Authorizationstringheaderrequired

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

Body

querystringrequired

Consulta de búsqueda en lenguaje natural.

Length: <= 500
limitinteger

Número máximo de resultados a devolver.

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

Response

application/json

Resultados de búsqueda

resultsarray<object>
results.titlestring

Título de la página.

results.sectionstring

Encabezado de sección dentro de la página (si aplica).

results.slugstring

Ruta URL de la página.

results.contentstring

Fragmento de contenido (máx. 500 chars).

results.urlstring<uri>

URL completa de la página.

results.scorenumber<float>

Puntuación de relevancia (similitud de coseno, 0.0–1.0). Mayor es mejor.

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

La consulta que se buscó.

totalinteger

Número de resultados devueltos.

durationMsinteger

Tiempo de ejecución de la búsqueda en el servidor en milisegundos (excluye el tiempo de red).