Riferimento API: ricerca

L’endpoint di ricerca esegue una ricerca globale (semantica) nei contenuti del tenant. Può provarlo nel Suo spazio di lavoro con una prova gratuita.

Ricerca globale tra ruoli, processi, elementi, documentazione, versioni e commenti del tenant

Il numero di richieste è limitato per tenant; una risposta 429 include il corpo del messaggio condiviso ({“message”: “Troppe richieste di ricerca, ridurre la frequenza.”}).

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

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	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 = embeddings, exact = letterale, hybrid = entrambi Valori consentiti: `semantic`, `exact`, `hybrid` Predefinito: `hybrid`
categories	`role` \| `process` \| `element` \| `documentation` \| `version` \| `comment`[]	No	Limita i risultati a queste categorie
processId	string	No	Limita i risultati a un solo processo Formato: `uuid`
k	integer	No	Numero di risultati da restituire Predefinito: `20` Min: 1 Max: 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
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 richieste raggiunto: consultare il limite documentato per l’endpoint

Documentazione correlata

Riferimento API: organizzazioni

Riferimento API per gli endpoint di gestione delle organizzazioni e degli utenti.

Riferimento API: tenant

Riferimento API per gli endpoint di gestione dei tenant e controllo degli accessi degli utenti.

Documentazione di riferimento dell’API: dati

Documentazione di riferimento dell’API per gli endpoint di gestione di dataset e tabelle dati.

Riferimento API: processi

Riferimento API per gli endpoint di gestione dei processi e mappatura dei dati.

Progettazione. Analisi. Miglioramento. Costruisca un’architettura dei processi integrata e mantenga il controllo.

Acceda subito, senza carta di credito né attese. Trasformi il modo in cui opera la Sua organizzazione in una progettazione dei processi chiara e interconnessa.

Definisca l’architettura dei processi, le responsabilità e i controlli, e allinei ruoli e compiti a ogni livello.

Inizi la prova gratuita e crei una base affidabile per governare, gestire e migliorare costantemente i processi della Sua organizzazione.

Inizi ora la prova gratuita