Sur cette page
> ressources > documentation > api > Référence de l’API : recherche

Référence de l’API : recherche

Le point de terminaison de recherche effectue une recherche globale (sémantique) dans le contenu du tenant.

Recherche globale dans les rôles, processus, éléments, documents, versions et commentaires du tenant

Limitation du débit par tenant ; une réponse 429 contient le corps de message commun ({“message”: “Trop de requêtes de recherche, veuillez ralentir.”}).

Point de terminaison : POST /v1/tenant/{tenantId}/search

Authentification : Clé API limitée au tenant · portée read

Paramètres :

Nom Type Emplacement Obligatoire Description
tenantId string chemin Oui Format : uuid

Corps de la requête :

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Champ Type Obligatoire Description
query string Oui Requête de recherche
Longueur maximale : 1000
mode semantic | exact | hybrid Non semantic = embeddings, exact = littéral, hybrid = les deux
Valeurs autorisées : semantic, exact, hybrid
Valeur par défaut : hybrid
categories role | process | element | documentation | version | comment[] Non Limiter les résultats à ces catégories
processId string Non Limiter les résultats à un seul processus
Format : uuid
k integer Non Nombre de résultats à renvoyer
Valeur par défaut : 20
Minimum : 1
Maximum : 50

Réponse (200) :

Résultats de recherche (occurrences, compteurs, total, suggestions)

{
	"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"
	]
}
Champ Type Obligatoire Description
hits object[] Oui
counts object Oui
total number Oui
suggestions string[] Oui

Erreurs :

  • 401 Clé API manquante, non valide, désactivée ou expirée
  • 429 Limitation du débit : consultez la limite de débit documentée pour le point de terminaison

Documentation associée