搜索文档。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AgentKey |
string |
否 |
业务空间 key,不设置则访问默认业务空间，key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
| Keyword |
string |
否 |
关键字 |
搜索关键字 |
| CategoryIds |
array |
否 |
类目 ID 列表 |
|
|
integer |
否 |
类目 ID |
30000065594 |
|
| ProcessStatus |
integer |
否 |
任务状态 -1 排队中 0 成功 1 解析中 2 处理中 3 处理失败 |
0 |
| Status |
integer |
否 |
编辑状态： 1 未发布 2 已发布 3 已更新未发布 |
1 |
| SearchScope |
integer |
否 |
搜索范围 1 搜索标题 2 搜索内容 |
1 |
| CreateUserName |
string |
否 |
创建人名称 |
张三 |
| ModifyUserName |
string |
否 |
修改人名称 |
李四 |
| 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 |
| PageSize |
integer |
否 |
每页数量 |
10 |
| TagIds |
array |
否 |
标签 ID 列表，多个标签时，采用“并集”逻辑进行筛选 |
|
|
integer |
否 |
标签 ID |
1201 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
E3E5C779-A630-45AC-B0F2-A4506A4212F1 |
| PageNumber |
integer |
当前⻚码 |
1 |
| PageSize |
integer |
每页数量 |
10 |
| TotalCount |
integer |
总条数 |
141 |
| DocHits |
array<object> |
文档列表 |
|
|
array<object> |
|||
| KnowledgeId |
integer |
知识 ID |
30002692007 |
| DocName |
string |
文档名称 |
文档名称 |
| BizCode |
string |
业务代码 |
cn_dytns |
| Meta |
string |
文档随路数据 |
{"code":"xxx"} |
| Config |
string |
文档解析/切分配置 配置项：切分器 KEY：Splitter 值选项：paragraphSplitter-识别层级【默认】 值选项：treeSplitter-规则层级 配置项：文档切块大小 KEY：ChunkSize VALUE：默认 500；范围[200,800] 配置项：规则层级 KEY：TreePatterns VALUE：默认[] 配置项：文档标题来源 KEY：TitleSource 值选项：ocrTitle - OCR 识别标题【默认】 值选项：docName - 文档名即标题 |
{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"} |
| Url |
string |
文档保存 OSS 地址 |
https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf |
| ModifyTime |
string |
修改时间（UTC 时间） |
2023-06-25T02:27:42Z |
| ModifyUserName |
string |
修改人名称 |
李四 |
| CreateTime |
string |
创建时间（UTC 时间） |
2023-06-22T03:53:41Z |
| CreateUserName |
string |
创建人名称 |
张三 |
| CreateUserId |
integer |
创建人 ID |
111111111 |
| ModifyUserId |
integer |
修改人 ID |
222222222 |
| CategoryId |
integer |
类目 ID |
30000135654 |
| ProcessStatus |
integer |
任务处理状态 -1 排队中 0 成功 1 解析中 2 处理中 3 处理失败 |
0 |
| ProcessMessage |
string |
任务处理信息 |
任务处理成功 |
| ProcessCanRetry |
boolean |
任务是否可重试 true：可重试 false：不可重试 |
true |
| Status |
integer |
编辑状态： 1 未发布 2 已发布 3 已更新未发布 |
1 |
| EffectStatus |
integer |
知识生效状态，根据 StartDate，EndDate 计算出来：20-生效中，21-已失效，22-待生效 |
20 |
| StartDate |
string |
生效时间（UTC 时间） |
2023-02-28T11:40:18Z |
| EndDate |
string |
失效时间（UTC 时间） |
2099-12-31T16:00:00Z |
| DocTags |
array<object> |
标签详情列表 |
|
|
object |
标签详情 |
||
| TagId |
integer |
标签 ID |
1201 |
| TagName |
string |
标签名称 |
小说 |
| GroupId |
integer |
标签组 ID |
3610 |
| GroupName |
string |
标签组名称 |
文章 |
| DefaultTag |
boolean |
是否默认全部标签 |
false |
示例
正常返回示例
JSON格式
{
"RequestId": "E3E5C779-A630-45AC-B0F2-A4506A4212F1",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 141,
"DocHits": [
{
"KnowledgeId": 30002692007,
"DocName": "文档名称",
"BizCode": "cn_dytns",
"Meta": "{\"code\":\"xxx\"}",
"Config": "{\"Splitter\":\"treeSplitter\",\"ChunkSize\":500,\"TreePatterns\":[\"^# .*\",\"^## .*\",\"^### .*\",\"^#### .*\"],\"TitleSource\":\"docName\"}",
"Url": "https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf",
"ModifyTime": "2023-06-25T02:27:42Z",
"ModifyUserName": "李四",
"CreateTime": "2023-06-22T03:53:41Z",
"CreateUserName": "张三",
"CreateUserId": 111111111,
"ModifyUserId": 222222222,
"CategoryId": 30000135654,
"ProcessStatus": 0,
"ProcessMessage": "任务处理成功",
"ProcessCanRetry": true,
"Status": 1,
"EffectStatus": 20,
"StartDate": "2023-02-28T11:40:18Z",
"EndDate": "2099-12-31T16:00:00Z",
"DocTags": [
{
"TagId": 1201,
"TagName": "小说",
"GroupId": 3610,
"GroupName": "文章",
"DefaultTag": false
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。