En esta página
> recursos > documentacion > api > Referencia de API: búsqueda

Referencia de API: búsqueda

El endpoint de búsqueda realiza una búsqueda global (semántica) en el contenido del inquilino.

Búsqueda global en los Roles, procesos, elementos, documentación, versiones y comentarios del inquilino

El límite de frecuencia se aplica por inquilino; una respuesta 429 incluye el cuerpo de mensaje compartido ({“message”: “Demasiadas solicitudes de búsqueda; reduzca la frecuencia.”}).

Endpoint: POST /v1/tenant/{tenantId}/search

Autenticación: Clave de API con ámbito de inquilino · ámbito read

Parámetros:

Nombre Tipo Ubicación Obligatorio Descripción
tenantId string ruta Sí Formato: uuid

Cuerpo de la solicitud:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Campo Tipo Obligatorio Descripción
query string Sí Consulta de búsqueda
Longitud máxima: 1000
mode semantic | exact | hybrid No semantic = embeddings, exact = literal, hybrid = ambos
Valores permitidos: semantic, exact, hybrid
Valor predeterminado: hybrid
categories role | process | element | documentation | version | comment[] No Restringir los resultados a estas categorías
processId string No Restringir los resultados a un solo proceso
Formato: uuid
k integer No Número de resultados que se devolverán
Valor predeterminado: 20
Mínimo: 1
Máximo: 50

Respuesta (200):

Resultados de búsqueda (coincidencias, recuentos, total y sugerencias)

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}
Campo Tipo Obligatorio Descripción
hits object[] Sí
counts object Sí
total number Sí
suggestions string[] Sí

Errores:

  • 401 Falta la clave de API, o esta no es válida, está deshabilitada o ha caducado
  • 429 Límite de frecuencia alcanzado: consulte el límite documentado del endpoint

Documentación relacionada