OpenAI File ( 文件 ) 接口

概述

文件接口主要用于为微调提供数据文件。涉及到上传、删除功能。

文件格式

微调文件扩展名为 .jsonl,数据格式如下 :

{"prompt": "1+1=?->", "completion": "4\nENDEND"}
{"prompt": "1加1=?->", "completion": "4\nENDEND"}

查询文件列表

GET 请求

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

响应结果

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

文件上传

POST 请求

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

POST 请求数据

file
字符串 必填 要上传的JSON 行文件的名称。

purpose
字符串 必填 上传文件的预期目的。

响应结果

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

删除文件

GET 请求

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

响应结果

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