เนื้อหาในหน้านี้
> ทรัพยากร > เอกสาร > api > เอกสารอ้างอิง API: การค้นหา

เอกสารอ้างอิง API: การค้นหา

Endpoint ค้นหาจะค้นหาเนื้อหาทั้งหมดใน Tenant แบบทั่วถึง (เชิงความหมาย) คุณทดลองใช้กับ workspace ของคุณเองได้ด้วย ทดลองใช้ฟรี.

ค้นหาทั่วทั้งบทบาท กระบวนการ องค์ประกอบ เอกสาร เวอร์ชัน และความคิดเห็นใน tenant

จำกัดอัตราการเรียกใช้แยกตาม Tenant การตอบกลับ 429 จะมีเนื้อหาข้อความที่ใช้ร่วมกัน ({“message”: “มีคำขอค้นหามากเกินไป โปรดลองใหม่ช้าลง”}).

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

การยืนยันตัวตน: API key ที่จำกัดขอบเขตตาม tenant · read scope

พารามิเตอร์:

ชื่อ ประเภท ตำแหน่ง จำเป็น คำอธิบาย
tenantId string path ใช่ รูปแบบ: uuid

เนื้อหาคำขอ:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
ฟิลด์ ประเภท จำเป็น คำอธิบาย
query string ใช่ คำค้นหา
ความยาวสูงสุด: 1000
mode semantic | exact | hybrid ไม่ semantic = ค้นหาด้วย embeddings, exact = ค้นหาตรงตามข้อความ, hybrid = ใช้ทั้งสองแบบ
ค่าที่ใช้ได้: semantic, exact, hybrid
ค่าเริ่มต้น: hybrid
categories role | process | element | documentation | version | comment[] ไม่ จำกัดผลลัพธ์ให้แสดงเฉพาะหมวดหมู่เหล่านี้
processId string ไม่ จำกัดผลลัพธ์ให้ค้นหาเฉพาะกระบวนการเดียว
รูปแบบ: uuid
k integer ไม่ จำนวนผลลัพธ์ที่ต้องการ
ค่าเริ่มต้น: 20
ค่าต่ำสุด: 1
ค่าสูงสุด: 50

การตอบกลับ (200):

ผลการค้นหา (รายการที่พบ จำนวน ยอดรวม คำแนะนำ)

{
	"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"
	]
}
ฟิลด์ ประเภท จำเป็น คำอธิบาย
hits object[] ใช่
counts object ใช่
total number ใช่
suggestions string[] ใช่

ข้อผิดพลาด:

  • 401 ไม่มี API key, API key ไม่ถูกต้อง ถูกปิดใช้งาน หรือหมดอายุ
  • 429 เรียกใช้เกินอัตราที่กำหนด ดูอัตราการเรียกใช้ที่ระบุไว้ในเอกสารของ endpoint

เอกสารที่เกี่ยวข้อง

ออกแบบกระบวนการให้ดีขึ้น วางโครงสร้างที่เชื่อมโยงกัน และควบคุมได้.

เริ่มใช้งานได้ทันที ไม่ต้องใช้บัตรเครดิตและไม่ต้องรอ เปลี่ยนวิธีทำงานขององค์กรให้เป็นแบบจำลองกระบวนการที่ชัดเจนและเชื่อมโยงกัน.

สร้างสถาปัตยกรรมกระบวนการ กำหนดเจ้าของและการควบคุม พร้อมจัดบทบาทและความรับผิดชอบให้สอดคล้องกันในทุกระดับ.

เริ่มทดลองใช้ฟรี แล้วสร้างรากฐานที่เชื่อถือได้สำหรับกำกับดูแล จัดการ และปรับปรุงกระบวนการอย่างต่อเนื่อง.

เริ่มทดลองใช้ฟรีวันนี้