Op deze pagina
> bronnen > documentatie > api > API referentie: Search

API-referentie: Search

Het search-endpoint voert een globale semantische zoekopdracht uit in de content van de tenant.

Globaal zoeken in rollen, processen, elementen, documentatie, versies en opmerkingen van de tenant

Per tenant geldt een limiet; een 429-response bevat de gedeelde message body ({“message”: “Too many search requests, please slow down.”}).

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

Auth: API-sleutel met tenant-scope · read scope

Parameters:

Naam Type Locatie Verplicht Beschrijving
tenantId string path Ja Indeling: uuid

Request body:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Veld Type Verplicht Beschrijving
query string Ja Zoekopdracht
Maximale lengte: 1000
mode semantic | exact | hybrid Nee semantic = embeddings, exact = letterlijk, hybrid = beide
Toegestane waarden: semantic, exact, hybrid
Standaard: hybrid
categories role | process | element | documentation | version | comment[] Nee Resultaten beperken tot deze categorieën
processId string Nee Resultaten beperken tot één proces
Indeling: uuid
k integer Nee Aantal resultaten dat wordt geretourneerd
Standaard: 20
Minimum: 1
Maximum: 50

Response (200):

Searchresultaten (hits, aantallen, totaal, suggesties)

{
	"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"
	]
}
Veld Type Verplicht Beschrijving
hits object[] Ja
counts object Ja
total number Ja
suggestions string[] Ja

Fouten:

  • 401 Ontbrekende, ongeldige, uitgeschakelde of verlopen API-sleutel
  • 429 Rate limit bereikt: bekijk de gedocumenteerde limiet van het endpoint

Gerelateerde documentatie