文件 Files

文件用于上传可与微调等功能一起使用的文档 OpenAi 中文官方api文档

列出文件

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

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

请求示例

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

响应示例

json
{
  "data": [
    {
      "id": "file-ccdDZrC3iZVNiQVeEA6Z66wf",
      "object": "file",
      "bytes": 175,
      "created_at": 1613677385,
      "filename": "train.jsonl",
      "purpose": "search"
    },
    {
      "id": "file-XjGxS3KTG0uNmNOK362iJua3",
      "object": "file",
      "bytes": 140,
      "created_at": 1613779121,
      "filename": "puppy.jsonl",
      "purpose": "search"
    }
  ],
  "object": "list"
}

上传文件

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

上传包含要跨各种端点/功能使用的文档的文件。 目前，一个组织上传的所有文件的大小最大可达 1 GB。 如果您需要增加存储限制，请联系我们。

请求体

file string Required

要上传的 JSON 行 文件的名称。

如果 purpose 设置为“fine-tune”，则每一行都是一个 JSON 记录，其中包含代表您的训练样例 的prompt和completion字段。

purpose string Required

上传文件的预期目的。

使用微调使我们能够验证上传文件的格式。

请求示例

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

响应示例

json
{
  "id": "file-XjGxS3KTG0uNmNOK362iJua3",
  "object": "file",
  "bytes": 140,
  "created_at": 1613779121,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune"
}

删除文件

delete https://api.openai.com/v1/files/{file\_id}

路径参数

file_id string Required

用于此请求的文件的 ID

请求示例

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

响应示例

json
{
  "id": "file-XjGxS3KTG0uNmNOK362iJua3",
  "object": "file",
  "deleted": true
}

检索文件

get https://api.openai.com/v1/files/{file\_id}

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

路径参数

file_id string Required

用于此请求的文件的 ID

请求示例

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

响应示例

json
{
  "id": "file-XjGxS3KTG0uNmNOK362iJua3",
  "object": "file",
  "bytes": 140,
  "created_at": 1613779657,
  "filename": "mydata.jsonl",
  "purpose": "fine-tune"
}

检索文件内容

get https://api.openai.com/v1/files/{file\_id}/content

返回指定文件的内容

路径参数

file_id string Required

用于此请求的文件的 ID

请求示例

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

.