OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

文件

Files 用于上传可与 Assistants、Fine-tuning 和 Batch API 等功能一起使用的文档。source

上传文件

POST https://api.openai.com/v1/files

上传可跨各种终端节点使用的文件。单个文件最大为 512 MB，一个组织上传的所有文件的大小最大为 100 GB。source

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

Fine-tuning API 仅支持.jsonl文件。input 还具有微调聊天或完成模型所需的某些格式。source

Batch API 仅支持.jsonl文件大小不超过 200 MB 的文件。input 还具有特定的 required 格式。source

如果您需要提高这些仓储限制，请联系我们。source

请求正文

文件

文件source

必填

要上传的 File 对象（不是文件名）。source

目的

字符串source

必填

上传文件的预期用途。source

使用 “assistants” 表示 Assistants 和 Message 文件，使用 “vision” 表示 Assistants 图像文件输入，使用 “batch” 表示 Batch API，使用 “fine-tune” 进行微调。source

上传的 File 对象。source

示例请求

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

1
2
3
4
5
6
7
from openai import OpenAI
client = OpenAI()

client.files.create(
  file=open("mydata.jsonl", "rb"),
  purpose="fine-tune"
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import fs from "fs";
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const file = await openai.files.create({
    file: fs.createReadStream("mydata.jsonl"),
    purpose: "fine-tune",
  });

  console.log(file);
}

main();

响应

1
2
3
4
5
6
7
8
{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune",
}

列出文件

获取 https://api.openai.com/v1/files

返回文件列表。source

查询参数

目的

字符串source

可选

仅返回具有给定目的的文件。source

限制

整数source

可选

默认为 10000

要返回的对象数量限制。Limit 的范围可以介于 1 到 10,000 之间，默认值为 10,000。source

次序

字符串source

可选

默认为 desc

按created_at对象的时间戳。asc对于升序和desc以降序排列。source

后

字符串source

可选

用于分页的游标。after是定义您在列表中的位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则您的后续调用可以包含 after=obj_foo 以便获取列表的下一页。source

File 对象的列表。source

示例请求

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

1
2
3
4
from openai import OpenAI
client = OpenAI()

client.files.list()

1
2
3
4
5
6
7
8
9
10
11
12
13
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const list = await openai.files.list();

  for await (const file of list) {
    console.log(file);
  }
}

main();

响应

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "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"
}

检索文件

获取 https://api.openai.com/v1/files/{file_id}

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

路径参数

file_id

字符串source

必填

用于此请求的文件的 ID。source

与指定 ID 匹配的 File 对象。source

示例请求

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

1
2
3
4
from openai import OpenAI
client = OpenAI()

client.files.retrieve("file-abc123")

1
2
3
4
5
6
7
8
9
10
11
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const file = await openai.files.retrieve("file-abc123");

  console.log(file);
}

main();

响应

1
2
3
4
5
6
7
8
{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune",
}

删除文件

删除 https://api.openai.com/v1/files/{file_id}

删除文件。source

路径参数

file_id

字符串source

必填

用于此请求的文件的 ID。source

删除状态。source

示例请求

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

1
2
3
4
from openai import OpenAI
client = OpenAI()

client.files.delete("file-abc123")

1
2
3
4
5
6
7
8
9
10
11
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const file = await openai.files.del("file-abc123");

  console.log(file);
}

main();

响应

1
2
3
4
5
{
  "id": "file-abc123",
  "object": "file",
  "deleted": true
}

检索文件内容

获取 https://api.openai.com/v1/files/{file_id}/content

返回指定文件的内容。source

路径参数

file_id

字符串source

必填

用于此请求的文件的 ID。source

文件内容。source

示例请求

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

1
2
3
4
from openai import OpenAI
client = OpenAI()

content = client.files.content("file-abc123")

1
2
3
4
5
6
7
8
9
10
11
import OpenAI from "openai";

const openai = new OpenAI();

async function main() {
  const file = await openai.files.content("file-abc123");

  console.log(file);
}

main();

file 对象

这Fileobject 表示已上传到 OpenAI 的文档。source

身份证

字符串source

文件标识符，可在 API 终端节点中引用。source

字节

整数source

文件大小（以字节为单位）。source

created_at

整数source

创建文件时的 Unix 时间戳（以秒为单位）。source

文件名

字符串source

文件的名称。source

对象

字符串source

对象类型，始终为file.source

目的

字符串source

文件的预期用途。支持的值包括assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-results和vision.source

地位

已废弃

字符串source

已废弃。文件的当前状态，可以是uploaded,processed或error.source

status_details

已废弃

字符串source

已废弃。有关微调训练文件未通过验证的原因的详细信息，请参阅error字段fine_tuning.job.source

OBJECT 文件对象

1
2
3
4
5
6
7
8
{
  "id": "file-abc123",
  "object": "file",
  "bytes": 120000,
  "created_at": 1677610602,
  "filename": "salesOverview.pdf",
  "purpose": "assistants",
}