按分类名称查询知识库问题
按分类名称查询知识库问题。
接口级参数规则:robotId 不传默认 -1;limit 不传或小于等于 0 时默认 10,最大 1000;startTime 和 endTime 必须大于 0,startTime 不能大于 endTime,endTime 不能晚于当前时间,查询跨度不能超过 31 天。
请求字段限制:
- robotId:选填,机器人 ID,不传默认 -1 表示企业默认机器人,默认值:-1
- categoryName:选填,数组
- startTime:选填,查询开始时间,毫秒时间戳;不传默认近 7 天
- endTime:选填,查询结束时间,毫秒时间戳;不传默认当前时间,不能晚于当前时间
- limit:选填,返回条数,不传默认 10,最大 1000,最大值 1000,默认值:10
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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,不传默认 -1 表示企业默认机器人 | 123456 |
| categoryName | string[] | 否 | ||
| startTime | int64 | 否 | 查询开始时间,毫秒时间戳;不传默认近 7 天 | 1700000000000 |
| endTime | int64 | 否 | 查询结束时间,毫秒时间戳;不传默认当前时间,不能晚于当前时间 | 1700100000000 |
| limit | int32 | 否 | 返回条数,不传默认 10,最大 1000 | 10 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务状态码,200 表示成功 | 200 |
| message | string | 响应消息 | success |
| data | object[] | 业务数据列表 | |
| └question | string | 知识点问题 | |
| total | int32 | 分页总数,分页接口返回 | 100 |
| requestId | string | 链路请求 ID | 0a1b2c3d4e5f |
| result | object | 部分历史接口使用 result 字段承载业务数据 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 缺失或不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体不是合法 JSON 对象,或参数缺失、格式非法 |
| 14009 | 频控限制:接口调用超过限流阈值 |
| 14500 | 服务内部错误 |
| 14501 | 数据查询范围超出限制 |
| 14515 | 当前 AppKey 无接口或资源访问权限 |
/openapi/robot/data/getQuestionsByCategoryNamecurl -X POST "https://qiyukf.com/openapi/robot/data/getQuestionsByCategoryName?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \ -H "Content-Type: application/json" \ -d '{ "limit": 10, "startTime": 1700000000000, "endTime": 1700100000000, "robotId": 123456, "categoryName": [ "订单问题" ] }'{
"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": "未开通机器人服务"
}这篇文档有帮助吗?
搜索知识库
搜索知识库。 接口级参数规则: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
分页拉取企业机器人知识库
分页拉取企业机器人知识库。 接口级参数规则:mid 不传默认 0;size 不传或小于等于 0 时默认 200,最大 1000;请求体长度最大 200。 请求字段限制: - mid:选填,上一页返回的最大知识 ID,不传默认 0,默认值:0 - size:选填,单次拉取数量,不传默认 200,最大 1000,最大值 1000,默认值:200