上传本地文件到知识库

上传本地文件,供创建或追加知识库来源使用。上传成功只表示文件已保存,不表示内容已可检索。

POST https://api.moi.matrixorigin.cn/v5/semantic-models/{model_id}/local-files/upload

调用前准备

查询知识库列表取得目标知识库 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

该接口的请求类型为 multipart/form-data;示例使用 curl -F 提交文件,不要添加 Content-Type: application/json

请求参数

curl -X POST "https://api.moi.matrixorigin.cn/v5/semantic-models/$MODEL_ID/local-files/upload" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -F "file=@./product-guide.pdf"

字段

类型

必填

说明

model_id

integer

目标知识库 ID。

字段

类型

必填

说明

file

file

要上传的本地文件。

成功响应

成功时返回 200。保存 data.file_id,将该值构造成 local_file 来源,再调用添加数据源接口。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file_01"
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

本次操作的返回数据。

下面表格展开响应示例中 data 对象;每一行是该对象的一个字段。

字段

类型

说明

file_id

string

已上传文件的 ID;添加本地文件来源时使用该值。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "file is required",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

面向调用者的错误信息。

data

null

发生错误时为 null

后续操作

使用 data.file_id 添加数据源

最后更新于