本页内容

API参考:搜索

搜索端点会对环境中的内容执行全局(语义)搜索。您可以通过免费试用在自己的工作空间中体验。

全局搜索租户中的角色、流程、元素、文档、版本和评论

每个租户的请求均受速率限制;429响应会返回通用消息正文({“message”: “Too many search requests, please slow down.”})。

端点: POST /v1/tenant/{tenantId}/search

**身份验证:**租户范围的API密钥 · read权限范围

参数:

名称 类型 位置 必填 说明
tenantId string 路径 是 格式:uuid

请求正文:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
字段 类型 必填 说明
query string 是 搜索查询
最大长度:1000
mode semantic | exact | hybrid 否 semantic表示向量搜索,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密钥
  • 429请求频率超限:请参阅端点文档中的速率限制说明

优化流程,构建互联架构,掌控全局。

无需信用卡,也无需等待,即刻开始。将组织的实际工作方式转化为清晰、互联的流程设计。

构建流程架构,明确职责归属与管控措施,并在各层级统一角色分工。

开始免费试用,为流程治理、管理和持续改进建立可靠的统一基础。