搜索知识库

搜索知识库。

接口级参数规则：robotId 必填；pageSize 默认 10、最大 200；minUpdateTime 与 maxUpdateTime 同传时，minUpdateTime 不能大于 maxUpdateTime。

请求字段限制：

robotId：必填，机器人 ID
categoryId：选填，分类 ID，不传默认 -1 表示全部分类，默认值：-1
pageSize：选填，每页条数，不传默认 10，最大 200，最大值 200，默认值：10
curPage：选填，页码，不传默认 1，默认值：1
keyWord：选填，搜索关键词
minUpdateTime：选填，最小更新时间，毫秒时间戳
maxUpdateTime：选填，最大更新时间，毫秒时间戳；与 minUpdateTime 同传时不得小于 minUpdateTime
deleted：选填，是否查询已删除知识，默认 false，默认值：false

请求参数

名称	类型	必填	描述	示例值
appKey	string	是	应用 AppKey	1c088a89de51d0af457616605f28390f
time	int64	是	请求时间戳（秒）；与服务器时间误差超过 10 分钟会鉴权失败	1511832531
checksum	string	是	请求签名校验和	f570a5eb049eb803b086e45829b07e48
checksumAlgorithm	int32	否	签名算法：0-SHA-1，1-SHA-256；不传默认为 0（SHA-1）	0

请求体

名称	类型	必填	描述	示例值
robotId	int64	是	机器人 ID	123456
categoryId	int64	否	分类 ID，不传默认 -1 表示全部分类	-1
pageSize	int64	否	每页条数，不传默认 10，最大 200	20
curPage	int64	否	页码，不传默认 1	1
keyWord	string	否	搜索关键词	发货
minUpdateTime	int64	否	最小更新时间，毫秒时间戳	1700000000000
maxUpdateTime	int64	否	最大更新时间，毫秒时间戳；与 minUpdateTime 同传时不得小于 minUpdateTime	1700100000000
deleted	boolean	否	是否查询已删除知识，默认 false	false

返回参数

名称	类型	描述	示例值
code	int32	业务状态码，200 表示成功	200
message	string	响应消息	success
data	object[]	业务数据列表
└id	int64	标准问题 ID
└name	string	标准问题名称
└answer	string	问题答案，优先级为对外答案高于对内答案
└categoryId	int64	知识分类 ID
└updateTime	int64	最后更新时间，毫秒时间戳
└questionStatus	int32	问题状态：0-未生效，1-有效，2-有效期内有效，3-失效，4-未生效
└effectiveTime	int64	生效时间，毫秒时间戳
└failureTime	int64	失效时间，毫秒时间戳
total	int32	分页总数，分页接口返回	100
requestId	string	链路请求 ID	0a1b2c3d4e5f
result	object	部分历史接口使用 result 字段承载业务数据

错误码

状态码	描述
14001	AppKey 缺失或不存在
14002	checksum 校验失败
14003	请求时间戳与服务器时间误差超过 10 分钟
14004	请求体不是合法 JSON 对象，或参数缺失、格式非法
14009	频控限制：接口调用超过限流阈值
14500	服务内部错误
14501	数据查询范围超出限制
14515	当前 AppKey 无接口或资源访问权限

postEndpoint

/openapi/ai/knowledge/search

curl -X POST "https://qiyukf.com/openapi/ai/knowledge/search?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \  -H "Content-Type: application/json" \  -d '{    "minUpdateTime": 1700000000000,    "maxUpdateTime": 1700100000000,    "curPage": 1,    "pageSize": 20,    "robotId": 123456,    "categoryId": -1,    "keyWord": "发货"  }'

{
  "code": 200,
  "data": {},
  "message": "success"
}

{
  "code": 14001,
  "message": "AppKey not exists"
}

{
  "code": 14002,
  "message": "Bad checksum"
}

{
  "code": 14003,
  "message": "Bad time"
}

{
  "code": 14004,
  "message": "body内容json解析错误"
}

{
  "code": 14009,
  "message": "单位时间内请求过于频繁"
}

{
  "code": 14500,
  "message": "Internal error"
}

{
  "code": 14501,
  "message": "Data limit exceeded"
}

{
  "code": 14515,
  "message": "未开通机器人服务"
}