文档新建。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AgentKey | string | 否 | 业务空间 key,不传时访问默认业务空间,key 值在主账号业务管理页面获取 | ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
CategoryId | long | 是 | 文档类目 ID | 30000049006 |
Title | string | 是 | 文档标题 | 测试标题 |
Content | string | 否 | 文档内容,与 URL 二选一 | 测试内容 |
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":""} |
Meta | string | 否 | 文档随路数据 | {"code":"xxx"} |
StartDate | string | 否 | 生效开始时间 UTC | 2022-05-25T16:28:36Z |
EndDate | string | 否 | 生效结束时间 UTC | 2032-05-25T16:28:36Z |
Url | string | 否 | 文档链接 URL 路径,与 Content 二选一,支持 txt、pdf、markdown、doc、docx 格式(单个文件:最多 100 页,txt 小于 200K,pdf 小于 100M,markdown 小于 200K,doc 小于 100M,docx 小于 100M) | https://example.com/example.pdf |
TagIds | array | 否 | 标签 ID 列表 | |
long | 否 | 标签 ID | 1201 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "07B270A4-61D8-57F6-A609-A3C216CFB872",
"KnowledgeId": 30001905617
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-26 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-05-17 | OpenAPI 入参发生变更 | 查看变更详情 |