文件

查询文件列表

GET

/files

Python

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),
  base_url="https://dashscope.aliyuncs.com/compatible-mode/v1",
)

file_list = client.files.list(
  after="file-batch-xxx",
  limit=20
)
print(file_list.model_dump_json())

{
  "data": [
    {
      "id": "file-batch-xxx",
      "bytes": 27,
      "created_at": 1722480543,
      "filename": "test.txt",
      "object": "file",
      "purpose": "batch",
      "status": "processed",
      "status_details": null
    },
    {
      "id": "file-batch-yyy",
      "bytes": 431986,
      "created_at": 1718089390,
      "filename": "test.pdf",
      "object": "file",
      "purpose": "batch",
      "status": "processed",
      "status_details": null
    }
  ],
  "object": "list",
  "has_more": false
}

鉴权

string

header

必填

千问云 API Key。详见获取 API Key。

查询参数

string

分页游标。设置为当前页最后一项的 id，即可获取下一页数据。

示例:file-batch-xxx

integer

默认值2000

每页返回的文件数量，范围 1-2,000，默认值为 2,000。

取值范围：1 <= x <= 2000

enum<string>

按用途筛选文件，可选值：file-extract、batch。

可选值：file-extract,batch

string

筛选在此时间之前创建的文件，支持格式：yyyyMMddHHmmss、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、yyyyMMdd。

示例:20250306123000

string

筛选在此时间之后创建的文件，支持格式：yyyyMMddHHmmss、yyyy-MM-dd HH:mm:ss、yyyy-MM-dd、yyyyMMdd。

示例:20250306123000

响应

200-application/json

enum<string>

固定值 list。

可选值：list

object[]

文件对象列表。

显示子属性

string

文件的唯一标识符。

示例:file-fe-xxx

integer

文件大小，单位为字节。

示例:2055

integer

文件创建时间的 Unix 时间戳（秒）。

示例:1729065448

string

上传时的文件名。

示例:test.txt

enum<string>

固定值 file。

可选值：file

string

文件用途，可选值：batch、file-extract、batch_output。

示例:file-extract

string

文件当前状态。

示例:processed

string | null

状态的补充说明，无详细信息时为 null。

boolean

是否存在下一页数据。

Python

import os
from openai import OpenAI

client = OpenAI(
  api_key=os.getenv("DASHSCOPE_API_KEY"),
  base_url="https://dashscope.aliyuncs.com/compatible-mode/v1",
)

file_list = client.files.list(
  after="file-batch-xxx",
  limit=20
)
print(file_list.model_dump_json())

{
  "data": [
    {
      "id": "file-batch-xxx",
      "bytes": 27,
      "created_at": 1722480543,
      "filename": "test.txt",
      "object": "file",
      "purpose": "batch",
      "status": "processed",
      "status_details": null
    },
    {
      "id": "file-batch-yyy",
      "bytes": 431986,
      "created_at": 1718089390,
      "filename": "test.pdf",
      "object": "file",
      "purpose": "batch",
      "status": "processed",
      "status_details": null
    }
  ],
  "object": "list",
  "has_more": false
}