文件

文件用于上传可以与功能如Assistants、Fine-tuning和Batch API一起使用的文档。

单个文件最大可以达到512 MB，由一个组织上传的所有文件的大小最大可以达到100 GB。

Assistants API支持最多200万个令牌的特定文件类型的文件。有关详细信息，请参阅Assistants工具指南。

Fine-tuning API仅支持.jsonl文件。

Batch API仅支持最大为100 MB的.jsonl文件。

如果您需要增加这些存储限制，请联系我们。

上传文件

上传一个可以在各种端点上使用的文件。单个文件最大可以达到512 MB，由一个组织上传的所有文件的大小最大可以达到100 GB。

Assistants API支持最多200万个令牌的特定文件类型的文件。有关详细信息，请参阅Assistants工具指南。

Fine-tuning API仅支持.jsonl文件。

Batch API仅支持最大为100 MB的.jsonl文件。

请求正文

名称	类型	描述
`file`	file	要上传的File对象（不是文件名）。
`purpose`	string	上传的文件的预期用途。对于Assistants和Message文件，使用“assistants”，对于Assistants图像文件输入，使用“vision”，对于Batch API，使用“batch”，对于Fine-tuning，使用“fine-tune”。

上传的文件对象。

示例请求

curl https://api.openai.com/v1/files \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -F purpose="fine-tune" \
  -F file="@mydata.jsonl"

响应

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune"
}

列出文件

返回属于用户组织的文件列表。

查询参数

名称	类型	描述
`purpose`	string	可选的。仅返回具有给定用途的文件。

文件对象的列表。

示例请求

curl https://api.openai.com/v1/files \
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应

{
  "data": [
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 175,
      "created_at": 1613677385,
      "filename": "salesOverview.pdf",
      "purpose": "assistants"
    },
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 140,
      "created_at": 1613779121,
      "filename": "puppy.jsonl",
      "purpose": "fine-tune"
    }
  ],
  "object": "list"
}

检索文件

返回有关特定文件的信息。

路径参数

名称	类型	描述
`file_id`	string	要使用于此请求的文件的ID。

匹配指定ID的文件对象。

示例请求

curl https://api.openai.com/v1/files/file-abc123 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune"
}

删除文件

删除一个文件。

路径参数

名称	类型	描述
`file_id`	string	要使用于此请求的文件的ID。

删除状态。

示例请求

curl https://api.openai.com/v1/files/file-abc123 \
  -X DELETE \
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应

{
  "id": "file-abc123",
  "object": "file",
  "deleted": true
}

检索文件内容

返回指定文件的内容。

路径参数

名称	类型	描述
`file_id`	string	要使用于此请求的文件的ID。

文件内容。

示例请求

curl https://api.openai.com/v1/files/file-abc123/content \
  -H "Authorization: Bearer $OPENAI_API_KEY" > file.jsonl

文件对象

File对象表示已经上传到OpenAI的文档。

名称	类型	描述
`id`	string	可以在API端点中引用的文件标识符。
`bytes`	integer	文件的大小，以字节为单位。
`created_at`	integer	创建文件的Unix时间戳（以秒为单位）。
`filename`	string	文件的名称。
`object`	string	对象类型，始终为`file`。
`purpose`	string	文件的预期用途。支持的值为`assistants`，`assistants_output`，`batch`，`batch_output`，`fine-tune`，`fine-tune-results`和`vision`。
`status`	string	已弃用。文件的当前状态，可以是`uploaded`，`processed`或`error`。
`status_details`	string	已弃用。有关细节，请参阅`fine_tuning.job`中的`error`字段。

示例文件对象

{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "salesOverview.pdf",
  "purpose": "assistants"
}