In questa pagina
> risorse > documentazione > api > Riferimento API: Ricerca

Riferimento API: Ricerca

L’endpoint di ricerca esegue una ricerca globale (semantica) nei contenuti del tenant.

Ricerca globale nei ruoli, nei processi, negli elementi, nella documentazione, nelle versioni e nei commenti del tenant

Limitato in base al tenant; una risposta 429 contiene il corpo del messaggio condiviso ({“message”: “Troppe richieste di ricerca, rallentare.”}).

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

Autenticazione: Chiave API con ambito tenant · ambito read

Parametri:

Nome Tipo Posizione Obbligatorio Descrizione
tenantId string percorso Sì Formato: uuid

Corpo della richiesta:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Campo Tipo Obbligatorio Descrizione
query string Sì Query di ricerca
Lunghezza massima: 1000
mode semantic | exact | hybrid No semantic = incorporamenti, exact = letterale, hybrid = entrambi
Valori consentiti: semantic, exact, hybrid
Valore predefinito: hybrid
categories role | process | element | documentation | version | comment[] No Limita i risultati a queste categorie
processId string No Limita i risultati a un singolo processo
Formato: uuid
k integer No Numero di risultati da restituire
Valore predefinito: 20
Minimo: 1
Massimo: 50

Risposta (200):

Risultati della ricerca (corrispondenze, conteggi, totale, suggerimenti)

{
	"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 Obbligatorio Descrizione
hits object[] Sì
counts object Sì
total number Sì
suggestions string[] Sì

Errori:

  • 401 Chiave API mancante, non valida, disabilitata o scaduta
  • 429 Limite di frequenza raggiunto: consulti il limite di frequenza documentato per l’endpoint

Documentazione correlata