DescribeDoc_智能对话机器人_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
暂无数据

请求参数

字段名称字段详情
AgentKeystring

业务空间 key,不传时访问默认业务空间,key 值在主账号业务管理页面获取

示例值:ac627989eb4f8a98ed05fd098bbae5_p_beebot_public参考取值来源:
    GetAgentInfo
    ListAgent
KnowledgeIdinteger<int64>

知识 ID

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:30001979424取值 < 9223372036854775807
ShowDetailboolean

是否展示文档段落详细信息展开详情

示例值:false

返回参数

字段名称字段详情
RequestIdstring

Id of the request

示例值:7F132693-212A-40A9-8A81-11E7694E478B
KnowledgeIdinteger<int64>

知识 ID

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:30001979424
DocNamestring

文档名称

示例值:文档名称
Titlestring

文档标题

示例值:测试标题
BizCodestring

业务代码

示例值:bizcode123
Metastring

文档随路数据

示例值:{"code":"xxx"}
Configstring

文档解析/切分配置的配置项:切分器 KEY:Splitter 值选项:paragraphSplitter-识别层级【默认】 值选项:treeSplitter-规则层级展开详情

示例值:{"Splitter":"treeSplitter","ChunkSize":500,"TreePatterns":["^# .*","^## .*","^### .*","^#### .*"],"TitleSource":"docName"}
Urlstring

文档保存 OSS 地址

示例值:https://doc2bot-bucket-cloud.oss-cn-shanghai.aliyuncs.com/doc2bot/input/文档问答说明书_V1.pdf
ModifyTimestring

修改时间

示例值:2020-11-25T08:56:55Z
ModifyUserNamestring

修改人

示例值:李四
CreateTimestring

创建时间

示例值:2022-04-12T06:30:17Z
CreateUserNamestring

创建人名称

示例值:张三
CreateUserIdinteger<int64>

创建人 ID

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1111111111
ModifyUserIdinteger<int64>

修改人 ID

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:2222222222
CategoryIdinteger<int64>

类目 ID

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:30000049006
ProcessStatusinteger<int32>

任务处理状态展开详情

示例值:0
ProcessMessagestring

任务处理信息

示例值:任务处理成功
ProcessCanRetryboolean

任务是否可重试展开详情

示例值:true
Statusinteger<int32>

编辑状态:展开详情

示例值:1
EffectStatusinteger<int32>

生效状态展开详情

示例值:20
StartDatestring

生效时间(UTC 时间)

示例值:1979-12-31T16:00:00Z
EndDatestring

失效时间(UTC 时间)

示例值:2023-04-27T06:08:54Z
DocInfoobject

文档详情

DocTagsarray<object>

标签详情列表

DocMetadataarray<object>

变更历史

变更时间变更内容概要操作
2024-09-26
变更返回参数
2024-05-17
变更返回参数

相关示例