Na tej stronie
> zasoby > dokumentacja > api > Dokumentacja API: wyszukiwanie

Dokumentacja API: wyszukiwanie

Endpoint wyszukiwania przeszukuje globalnie treści tenanta, także semantycznie. Mogą Państwo przetestować go we własnym obszarze roboczym w ramach okresu próbnego.

Globalne wyszukiwanie ról, procesów, elementów, dokumentacji, wersji i komentarzy tenanta

Limit żądań jest ustalany osobno dla każdego tenanta. Odpowiedź 429 zawiera wspólną treść komunikatu ({“message”: “Too many search requests, please slow down.”}).

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

Uwierzytelnianie: Klucz API przypisany do tenanta · zakres read

Parametry:

Nazwa Typ Lokalizacja Wymagane Opis
tenantId string ścieżka Tak Format: uuid

Treść żądania:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Pole Typ Wymagane Opis
query string Tak Zapytanie wyszukiwania
Maksymalna długość: 1000
mode semantic | exact | hybrid Nie semantic = wektory osadzeń, exact = dopasowanie dosłowne, hybrid = oba tryby
Dozwolone wartości: semantic, exact, hybrid
Domyślnie: hybrid
categories role | process | element | documentation | version | comment[] Nie Ogranicz wyniki do tych kategorii
processId string Nie Ogranicz wyniki do jednego procesu
Format: uuid
k integer Nie Liczba zwracanych wyników
Domyślnie: 20
Min.: 1
Maks.: 50

Odpowiedź (200):

Wyniki wyszukiwania (trafienia, liczby, suma, sugestie)

{
	"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"
	]
}
Pole Typ Wymagane Opis
hits object[] Tak
counts object Tak
total number Tak
suggestions string[] Tak

Błędy:

  • 401 Brakujący, nieprawidłowy, wyłączony lub wygasły klucz API
  • 429 Przekroczono limit żądań. Szczegóły znajdują się w dokumentacji limitu dla tego endpointu.

Powiązana dokumentacja

Projektuj lepsze procesy. Buduj spójną architekturę. Zachowaj kontrolę.

Uzyskaj dostęp od razu, bez karty kredytowej i czekania. Przedstaw sposób działania organizacji w postaci przejrzystych, powiązanych modeli procesów.

Buduj architekturę procesów, określaj właścicieli i mechanizmy kontroli oraz uzgadniaj role i zakresy odpowiedzialności na każdym poziomie.

Rozpocznij okres próbny i stwórz solidną podstawę do nadzorowania, zarządzania i ciągłego doskonalenia procesów.

Rozpocznij okres próbny