文档详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AgentKey |
string |
否 |
业务空间 key，不传时访问默认业务空间，key 值在主账号业务管理页面获取 |
ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
| KnowledgeId |
integer |
是 |
知识 ID |
30001979424 |
| ShowDetail |
boolean |
否 |
是否展示文档段落详细信息 true：展示 false：忽略（默认） |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
7F132693-212A-40A9-8A81-11E7694E478B |
| KnowledgeId |
integer |
知识 ID |
30001979424 |
| DocName |
string |
文档名称 |
文档名称 |
| Title |
string |
文档标题 |
测试标题 |
| BizCode |
string |
业务代码 |
bizcode123 |
| 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 |
修改时间 |
2020-11-25T08:56:55Z |
| ModifyUserName |
string |
修改人 |
李四 |
| CreateTime |
string |
创建时间 |
2022-04-12T06:30:17Z |
| CreateUserName |
string |
创建人名称 |
张三 |
| CreateUserId |
integer |
创建人 ID |
1111111111 |
| ModifyUserId |
integer |
修改人 ID |
2222222222 |
| CategoryId |
integer |
类目 ID |
30000049006 |
| 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 时间） |
1979-12-31T16:00:00Z |
| EndDate |
string |
失效时间（UTC 时间） |
2023-04-27T06:08:54Z |
| DocInfo |
object |
文档详情 |
|
| DocParas |
array<object> |
文档段落信息 |
|
|
object |
段落对象 |
||
| ParaNo |
integer |
段落序号 |
1 |
| ParaLevel |
integer |
段落层级 |
1 |
| ParaType |
string |
段落内容类型 text-文本 figure-图片 table-表格 |
text |
| ParaText |
string |
段落内容【纯文本/图片 OCR 内容/表格的 Markdown 表示】 |
内容 |
| DocTags |
array<object> |
标签详情列表 |
|
|
object |
标签详情 |
||
| TagId |
integer |
标签 ID |
1201 |
| TagName |
string |
标签名称 |
小说 |
| GroupId |
integer |
标签分组 ID |
3610 |
| GroupName |
string |
标签分组名称 |
文章 |
| DefaultTag |
boolean |
是否默认为全部标签 |
false |
| DocMetadata |
array<object> |
||
|
array<object> |
|||
| BusinessViewId |
string |
||
| BusinessViewName |
string |
标签名称 |
|
| MetaCellInfoDTOList |
array<object> |
||
|
object |
|||
| FieldCode |
string |
||
| FieldName |
string |
||
| Value |
string |
示例
正常返回示例
JSON格式
{
"RequestId": "7F132693-212A-40A9-8A81-11E7694E478B",
"KnowledgeId": 30001979424,
"DocName": "文档名称",
"Title": "测试标题",
"BizCode": "bizcode123",
"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": "2020-11-25T08:56:55Z",
"ModifyUserName": "李四",
"CreateTime": "2022-04-12T06:30:17Z",
"CreateUserName": "张三",
"CreateUserId": 1111111111,
"ModifyUserId": 2222222222,
"CategoryId": 30000049006,
"ProcessStatus": 0,
"ProcessMessage": "任务处理成功",
"ProcessCanRetry": true,
"Status": 1,
"EffectStatus": 20,
"StartDate": "1979-12-31T16:00:00Z",
"EndDate": "2023-04-27T06:08:54Z",
"DocInfo": {
"DocParas": [
{
"ParaNo": 1,
"ParaLevel": 1,
"ParaType": "text",
"ParaText": "内容"
}
]
},
"DocTags": [
{
"TagId": 1201,
"TagName": "小说",
"GroupId": 3610,
"GroupName": "文章",
"DefaultTag": false
}
],
"DocMetadata": [
{
"BusinessViewId": "",
"BusinessViewName": "",
"MetaCellInfoDTOList": [
{
"FieldCode": "",
"FieldName": "",
"Value": ""
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。