Auf dieser Seite
> ressourcen > dokumentation > api > API Referenz: Suche

API-Referenz: Suche

Der Such-Endpunkt führt eine globale semantische Suche in den Inhalten des Mandanten durch.

Globale Suche in Rollen, Prozessen, Elementen, Dokumentation, Versionen und Kommentaren des Mandanten

Pro Mandant ratenbegrenzt; eine 429-Response enthält denselben Nachrichtentext ({“message”: “Too many search requests, please slow down.”}).

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

Authentifizierung: Mandantenbezogener API-Schlüssel · read-Bereich

Parameter:

Name Typ Ort Erforderlich Beschreibung
tenantId string path Ja Format: uuid

Request Body:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Feld Typ Erforderlich Beschreibung
query string Ja Suchanfrage
Maximale Länge: 1000
mode semantic | exact | hybrid Nein semantic = Embeddings, exact = wörtlich, hybrid = beides
Zulässige Werte: semantic, exact, hybrid
Standard: hybrid
categories role | process | element | documentation | version | comment[] Nein Ergebnisse auf diese Kategorien beschränken
processId string Nein Ergebnisse auf einen einzelnen Prozess beschränken
Format: uuid
k integer Nein Anzahl zurückzugebender Ergebnisse
Standard: 20
Minimum: 1
Maximum: 50

Response (200):

Suchergebnisse (Treffer, Anzahlen, Gesamtzahl, Vorschläge)

{
	"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"
	]
}
Feld Typ Erforderlich Beschreibung
hits object[] Ja
counts object Ja
total number Ja
suggestions string[] Ja

Fehler:

  • 401 Fehlender, ungültiger, deaktivierter oder abgelaufener API-Schlüssel
  • 429Ratenbegrenzung erreicht: Beachten Sie die dokumentierte Ratenbegrenzung des Endpunkts

Zugehörige Dokumentation