搜索知识。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AgentKey |
string |
否 |
业务空间 key，不设置则访问默认业务空间，key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
| Keyword |
string |
否 |
关键字 |
搜索标题 |
| CategoryIds |
array |
否 |
类目唯一标识 |
|
|
integer |
否 |
类目 ID |
30000065594 |
|
| Status |
integer |
否 |
知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布 枚举值：
|
1 |
| SearchScope |
integer |
否 |
搜索范围：1-搜索标题相似问，2-搜索答案，3-搜索全部 枚举值：
|
1 |
| CreateUserName |
string |
否 |
创建人 |
test01 |
| ModifyUserName |
string |
否 |
修改人 |
test01 |
| CreateTimeBegin |
string |
否 |
创建开始时间 |
2022-04-02T03:09:30Z |
| CreateTimeEnd |
string |
否 |
创建结束时间 |
2022-05-02T03:09:30Z |
| ModifyTimeBegin |
string |
否 |
修改开始时间 |
2023-04-02T03:09:30Z |
| ModifyTimeEnd |
string |
否 |
修改结束时间 |
2023-05-02T03:09:30Z |
| StartTimeBegin |
string |
否 |
生效开始时间 |
2022-04-02T03:09:30Z |
| StartTimeEnd |
string |
否 |
生效结束时间 |
2022-04-03T03:09:30Z |
| EndTimeBegin |
string |
否 |
失效开始时间 |
2023-04-02T03:09:30Z |
| EndTimeEnd |
string |
否 |
失效结束时间 |
2023-05-02T03:09:30Z |
| PageNumber |
integer |
否 |
页码默认 1 |
1 |
| PageSize |
integer |
否 |
每页数量，默认 10，最大 100 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回值 |
||
| FaqHits |
array<object> |
知识搜索结果 |
|
|
object |
知识信息 |
||
| KnowledgeId |
integer |
知识 ID |
30002145804 |
| ModifyTime |
string |
修改时间（UTC 时间） |
2022-04-02T03:09:30Z |
| ModifyUserName |
string |
修改人 |
test01 |
| CreateTime |
string |
创建时间（UTC 时间） |
2022-04-02T03:09:30Z |
| CreateUserName |
string |
创建人 |
test01 |
| CreateUserId |
integer |
创建人 ID |
18453 |
| ModifyUserId |
integer |
修改人 ID |
18453 |
| CategoryId |
integer |
类目 ID |
30000055639 |
| Status |
integer |
知识状态：-1-已删除未发布，1-未发布，2-已发布，3-已更新未发布 枚举值：
|
3 |
| EffectStatus |
integer |
知识生效状态，根据 StartDate，EndDate 计算出来：20-生效中，21-已失效，22-待生效 枚举值：
|
20 |
| Title |
string |
标题 |
测试标题 |
| HitSimilarTitles |
array |
命中的相似问题列表 |
|
|
string |
相似问题 |
测试命中的标题 |
|
| HitSolutions |
array |
命中的答案列表 |
|
|
string |
命中的答案 |
测试命中的答案 |
|
| PageNumber |
integer |
页码 |
1 |
| PageSize |
integer |
每页数量 |
10 |
| TotalCount |
integer |
总条数 |
1075 |
| RequestId |
string |
请求 ID |
E45491D5-7E0A-42C6-9B21-91D1066B1475 |
示例
正常返回示例
JSON格式
{
"FaqHits": [
{
"KnowledgeId": 30002145804,
"ModifyTime": "2022-04-02T03:09:30Z",
"ModifyUserName": "test01",
"CreateTime": "2022-04-02T03:09:30Z",
"CreateUserName": "test01",
"CreateUserId": 18453,
"ModifyUserId": 18453,
"CategoryId": 30000055639,
"Status": 3,
"EffectStatus": 20,
"Title": "测试标题",
"HitSimilarTitles": [
"测试命中的标题"
],
"HitSolutions": [
"测试命中的答案"
]
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1075,
"RequestId": "E45491D5-7E0A-42C6-9B21-91D1066B1475"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。