File

更新时间：2024-12-11

本文档描述与 File 相关的接口。请注意，此处的 File 不仅用于 Assistants 场景。

1.上传文件

功能介绍

上传文件，返回file_id

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files

请求方式：POST

请求参数

请参考公共类型定义中，公共请求头的定义

注意：本接口Content-Type为 multipart/form-data

Query

参数	语义	是否必填	取值/类型	备注
purpose	文件用途	否	string	默认为assistant

Body

参数名称	类型	描述
file	form-data	基于form-data格式上传文件 form key需要为file，单次仅能上传一篇文档

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files?purpose=test' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-F 'file=@"电子发票.pdf"'

响应说明

响应参数

Header

请参考公共类型定义中，公共响应头的定义

Body

参数名称	类型	描述
id	string	文件id
bytes	integer	文件字节数
object	string	返回值固定为file
purpose	string	文件用途
create_at	integer	创建时间
filename	string	进行安全文件名校验后的文件名，文件名中的中文字符以及控制字符，如`/`等会被过滤基于werkzeug.secure_filename进行规范校验
classification_id	string	分类id，这个值对应的是您的千帆app_id

响应示例

{
    "id": "file-534711451652165",
    "bytes": 39173,
    "object": "file",
    "purpose": "test",
    "create_at": 1712681190,
    "filename": "file",
    "classification_id": "123456"
}

2.查询已上传的文件列表

功能介绍

查询文件列表

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files/list

请求方式：POST

请求参数

Header

请参考公共类型定义中，公共请求头的定义

Body

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files/list' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'

响应说明

响应参数

Header

请参考公共类型定义中，公共响应头的定义

Body

参数名称	类型	描述
object	string	结构类型，返回值固定为 list
data	array[`Object`]	File对象列表
+id	string	文件id
+bytes	integer	文件字节数
+object	string	返回值固定为file
+purpose	string	文件用途
+censored	integer	文件审核状态，枚举值： -1: 审核中 0: 未审核 1: 审核通过 2: 审核不通过 3: 需要进一步审核 4. 审核失败（服务异常） 5. 审核失败（审核超时）
+create_at	integer	创建时间
+filename	string	进行安全文件名校验后的文件名，文件名中的中文字符以及控制字符，如`/`等会被过滤基于werkzeug.secure_filename进行规范校验
+classification_id	string	分类id，这个值对应的是您的千帆app_id
+file_type	string	文件类型

响应示例

{
    "data": [
        {
            "id": "file-537701124988997",
            "bytes": 12696269,
            "object": "file",
            "purpose": "",
            "censored": 1,
            "create_at": 1713411090,
            "filename": "test.png",
            "classification_id": "42685563",
            "file_type": "image"
        },
        {
            "id": "file-537777569275973",
            "bytes": 3617,
            "object": "file",
            "purpose": "",
            "censored": 1,
            "create_at": 1713429753,
            "filename": "api.txt",
            "classification_id": "42685563",
            "file_type": "document"
        }
    ],
    "object": "list"
}

3.查询已上传的文件信息

功能介绍

根据file_id查询文件信息

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files/query

请求方式：POST

请求参数

Header

请参考公共类型定义中，公共请求头的定义

Body

参数	语义	是否必填	取值/类型	备注
file_id	File对象的id	是	string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files/query' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "file_id": "file-534711451652165"
}'

响应说明

响应参数

Header

请参考公共类型定义中，公共响应头的定义

Body

参数名称	类型	描述
id	string	文件id
bytes	integer	文件字节数
object	string	返回值固定为file
purpose	string	文件用途
censored	integer	文件审核状态，枚举值： -1: 审核中 0: 未审核 1: 审核通过 2: 审核不通过 3: 需要进一步审核 4. 审核失败（服务异常） 5. 审核失败（审核超时）
create_at	integer	创建时间
filename	string	进行安全文件名校验后的文件名，文件名中的中文字符以及控制字符，如`/`等会被过滤基于werkzeug.secure_filename进行规范校验
classification_id	string	分类id，这个值对应的是您的千帆app_id

响应示例

{
    "id": "file-537701124988997",
    "bytes": 12696269,
    "object": "file",
    "purpose": "",
    "censored": 1,
    "create_at": 1713411090,
    "filename": "test.png",
    "classification_id": "42685563",
    "file_type": "image"
}

4.删除文件

功能介绍

根据file_id删除一个已上传的文件

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files/delete

请求方式：POST

请求参数

Header

请参考公共类型定义中，公共请求头的定义

Body

参数	语义	是否必填	取值/类型	备注
file_id	File对象的id	是	string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files/delete' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "file_id": "file-534711451652165"
}'

响应说明

响应参数

Header

请参考公共类型定义中，公共响应头的定义

Body

参数	类型	描述
id	string	File对象的id
object	string	结构类型，值固定为 file.deleted
deleted	bool	是否删除成功

响应示例

{
    "id": "file-534711451652165",
    "object": "file.deleted",
    "deleted": true
}

5.下载文件

功能介绍

根据file_id下载一个已上传的文件

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files/download

请求方式：POST

请求参数

Header

请参考公共类型定义中，公共请求头的定义

Body

参数	语义	是否必填	取值/类型	备注
file_id	File对象的id	是	string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files/download' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "file_id": "file-534711451652165"
}'

响应说明

响应参数

Header

参数	类型	描述
Content-Type	string	指示文件类型的MIME类型
Content-Disposition	string	客户端下载时的文件名

其他字段请参考公共类型定义中，公共响应头的定义

Body

二进制流

响应示例

二进制流

6.查看文件内容

功能介绍

查看文件内容

请求说明

基本信息

请求地址：https://appbuilder.baidu.com/v2/storage/files/content

请求方式：POST

请求参数

Header

请参考公共类型定义中，公共请求头的定义

Body

参数	语义	是否必填	取值/类型	备注
file_id	File对象的id	是	string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/storage/files/content' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "file_id": "file-534711451652165"
}'

响应说明

响应参数

Header

参数	类型	描述
Content-Type	string	指示文件类型的MIME类型

其他字段请参考公共类型定义中，公共响应头的定义

Body

二进制流

响应示例

二进制流