上传知识库文件

通过 OpenAPI 上传通义灵码知识库文件。

适用版本

企业专属版、企业标准版

服务接入点

获取服务接入点,替换 API 请求语法中的 {domain}

授权信息

产品

资源

所需权限

通义灵码

知识库文件

只读

请求语法

POST https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/files

请求说明

企业标准版

上传知识库文件

curl -X 'POST' \
  'https://openapi-rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases/b15aef8442c0fc45492b****/files?name=test.pdf' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --form 'file=@"path/to/file"'

企业专属版

上传知识库文件

curl -X 'POST' \
  'https://test-domain-***.rdc.aliyuncs.com/oapi/v1/lingma/organizations/6826e1d0516a9f85a08c****/knowledgeBases/b15aef8442c0fc45492b****/files?name=test.pdf' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --form 'file=@"path/to/file"'

请求头(Headers)

x-yunxiao-token string (必选)

个人访问令牌。您可参考个人访问令牌获取。

示例:pt-0fh3****0fbG_35af****0484。

请求参数

organizationId string (必选)

所属组织ID。您可以前往组织管理后台基本信息页面获取organizationId

kbId string (必选)

知识库 ID。请参见获取知识库列表获取知识库ID。

name string (可选)

文件名称,文件名称后缀需和待上传的真实文件保持一致。

file File 必选

待上传的真实文件,需要将file中的文件添加到请求体的form-data部分

返回参数

成功示例

{
    "fileId": "9536861f3bac806c6d14****",
    "operateUserId": "66a6f60e368d88cff5a5****",
    "success": true
}

失败示例

{
    "failed_message": "不支持该文件类型,请上传支持的文件格式。",
    "operateUserId": "66a6f60e368d88cff5a5****",
    "success": false
}

failedMessage string

失败的原因,如果成功则为空。

fileId string

日期。

operateUserId string

操作用户 id。

success boolean

是否成功。

错误码

访问错误码中心查看 API 相关错误码。