Tài liệu tham khảo API: Tìm kiếm

Endpoint tìm kiếm thực hiện tìm kiếm toàn cục (ngữ nghĩa) trên nội dung của tenant. Bạn có thể thử trên workspace của mình với dùng thử miễn phí.

Tìm kiếm toàn cục trong vai trò, quy trình, phần tử, tài liệu, phiên bản và bình luận của tenant

Giới hạn tốc độ áp dụng riêng cho từng tenant; phản hồi 429 chứa nội dung thông báo dùng chung ({“message”: “Có quá nhiều yêu cầu tìm kiếm, vui lòng giảm tốc độ.”}).

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

Xác thực: API key giới hạn theo tenant · phạm vi read

Tham số:

Nội dung yêu cầu:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}

Phản hồi (200):

Kết quả tìm kiếm (mục khớp, số lượng, tổng số, gợi ý)

{
	"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"
	]
}

Lỗi:

• 401 Thiếu, không hợp lệ, đã tắt hoặc hết hạn API key
• 429 Vượt giới hạn tốc độ: xem giới hạn được ghi trong tài liệu của endpoint