Bu sayfada
> kaynaklar > belgeler > api > API referansı: Arama

API referansı: Arama

Arama uç noktası, kiracının içeriğinde genel (anlamsal) arama yapar. Ücretsiz denemeyle kendi çalışma alanınızda deneyebilirsiniz.

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

Kiracı başına istek sınırı uygulanır; 429 yanıtı ortak ileti gövdesini içerir ({“message”: “Çok fazla arama isteği gönderildi, lütfen istek sıklığını azaltı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 path 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 vektörleri, exact = tam eşleşme, hybrid = 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
En az: 1
En fazla: 50

Yanıt (200):

Arama sonuçları (eşleşmeler, sayılar, 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 İstek sınırı aşıldı: uç nokta için belgelenen istek sınırına bakın

İlgili dokümantasyon

Süreçlerinizi daha iyi tasarlayın. Bağlantılı bir mimari kurun. Kontrolü elinizde tutun.

Kredi kartı gerekmeden, beklemeden hemen erişin. Kuruluşunuzdaki çalışma biçimini net ve birbiriyle bağlantılı süreç tasarımlarına dönüştürün.

Süreç mimarinizi oluşturun, sahiplik ve kontrolleri tanımlayın; rol ve sorumlulukları her düzeyde uyumlu hâle getirin.

Ücretsiz denemeyi başlatın; süreçlerinizi yönetmek ve sürekli iyileştirmek için güvenilir bir temel oluşturun.

Ücretsiz denemeyi başlatın