Bu sayfada
> kaynaklar > belgeler > api > API başvurusu: Arama

API başvurusu: Arama

Arama uç noktası, kiracının içeriğinde genel anlamsal arama yapar.

Kiracının rollerinde, süreçlerinde, öğelerinde, belgelerinde, sürümlerinde ve yorumlarında genel arama

Kiracı başına hız sınırı uygulanır; 429 yanıtı ortak mesaj gövdesini taşır ({“message”: “Çok fazla arama isteği gönderildi, lütfen yavaşlayın.”}).

Uç nokta: POST /v1/tenant/{tenantId}/search

Kimlik doğrulama: Kiracı kapsamlı API anahtarı · read kapsamı

Parametreler:

Ad Tür Konum Zorunlu Açıklama
tenantId string yol Evet Biçim: uuid

İstek gövdesi:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Alan Tür Zorunlu Açıklama
query string Evet Arama sorgusu
Maksimum uzunluk: 1000
mode semantic | exact | hybrid Hayır semantic = gömme, exact = birebir, hybrid = her ikisi
İzin verilen değerler: semantic, exact, hybrid
Varsayılan: hybrid
categories role | process | element | documentation | version | comment[] Hayır Sonuçları bu kategorilerle sınırlandırın
processId string Hayır Sonuçları tek bir süreçle sınırlandırın
Biçim: uuid
k integer Hayır Döndürülecek sonuç sayısı
Varsayılan: 20
Minimum: 1
Maksimum: 50

Yanıt (200):

Arama sonuçları (eşleşmeler, sayımlar, toplam, öneriler)

{
	"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"
	]
}
Alan Tür Zorunlu Açıklama
hits object[] Evet
counts object Evet
total number Evet
suggestions string[] Evet

Hatalar:

  • 401 Eksik, geçersiz, devre dışı veya süresi dolmuş API anahtarı
  • 429 Hız sınırına ulaşıldı: uç noktasının belgelenen hız sınırına bakın

İlgili dokümantasyon