Di halaman ini
> sumber daya > dokumentasi > api > Referensi API: Pencarian

Referensi API: Pencarian

Endpoint pencarian menelusuri seluruh konten tenant secara semantik. Anda dapat mencobanya di ruang kerja sendiri dengan uji coba gratis.

Cari secara global di seluruh peran, proses, elemen, dokumentasi, versi, dan komentar tenant

Batas permintaan berlaku untuk setiap tenant. Respons 429 berisi pesan yang sama ({“message”: “Terlalu banyak permintaan pencarian, kurangi frekuensinya.”}).

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

Autentikasi: API key khusus tenant · cakupan read

Parameter:

Nama Tipe Lokasi Wajib Deskripsi
tenantId string path Ya Format: uuid

Isi permintaan:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Kolom Tipe Wajib Deskripsi
query string Ya Kueri pencarian
Panjang maksimum: 1.000
mode semantic | exact | hybrid Tidak semantic = embeddings, exact = teks persis, hybrid = keduanya
Nilai yang diizinkan: semantic, exact, hybrid
Default: hybrid
categories role | process | element | documentation | version | comment[] Tidak Batasi hasil ke kategori berikut
processId string Tidak Batasi hasil ke satu proses
Format: uuid
k integer Tidak Jumlah hasil yang dikembalikan
Default: 20
Minimum: 1
Maksimum: 50

Respons (200):

Hasil pencarian (kecocokan, jumlah, total, saran)

{
	"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"
	]
}
Kolom Tipe Wajib Deskripsi
hits object[] Ya
counts object Ya
total number Ya
suggestions string[] Ya

Kesalahan:

  • 401API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa
  • 429Batas permintaan tercapai: lihat batas laju yang didokumentasikan untuk endpoint ini

Dokumentasi terkait

Rancang proses yang lebih baik. Bangun arsitektur yang saling terhubung. Tetap kendalikan semuanya.

Mulai sekarang juga tanpa kartu kredit dan tanpa perlu menunggu. Ubah cara kerja organisasi Anda menjadi rancangan proses yang jelas dan saling terhubung.

Bangun arsitektur proses, tetapkan penanggung jawab dan kontrol, lalu selaraskan peran serta tanggung jawab di setiap tingkat.

Mulai uji coba gratis dan bangun satu landasan tepercaya untuk mengatur, mengelola, dan terus memperbaiki proses Anda.

Mulai uji coba gratis hari ini