codecamp

OpenAI 列出文件接口

列出文件

get /files

返回文件列表。

查询参数

  • after: optional string

分页游标。after是定义列表当前位置的对象ID。例如,某次列表请求返回100个对象,最后一个为obj_foo,后续请求可包含after=obj_foo,获取下一页。

  • limit: optional integer(默认 10000)

要返回的对象数量上限,可在1到10000之间,默认10000。

  • order: optional "asc" or "desc"(默认 "desc")

按对象的created_at时间戳排序。asc表示升序,desc表示降序。

  • "asc"

  • "desc"

  • purpose: optional string

仅返回具有指定用途的文件。

返回值

  • data: array of FileObject

  • id: string

文件标识符,可在API端点中引用。

  • bytes: integer or null

文件大小,单位为字节。在已完成文件上传的响应中,如果文件大小尚不可用,此值可以为null。

  • created_at: integer(Unix 时间戳)

文件创建时的Unix时间戳,单位为秒。

  • filename: string

文件名称。

  • object: "file"

对象类型,固定为file。

  • "file"

  • purpose: "assistants" or "assistants_output" or "batch" or 5 more

文件的预期用途。支持的值为assistants、assistants_output、batch、batch_output、fine-tune、fine-tune-results、vision和user_data。

  • "assistants"

  • "assistants_output"

  • "batch"

  • "batch_output"

  • "fine-tune"

  • "fine-tune-results"

  • "vision"

  • "user_data"

  • status: "uploaded" or "processed" or "error"

已弃用。文件当前状态,可为uploaded、processed或error。

  • "uploaded"

  • "processed"

  • "error"

  • expires_at: optional integer(Unix 时间戳)

文件过期时的Unix时间戳,单位为秒。在已完成文件上传的响应中,如果未设置过期时间,此值可以为null。

  • status_details: optional string

已弃用。有关微调训练文件未通过验证的原因,请查看fine_tuning.job的error字段。已完成文件上传的响应在未设置这些详情时可以返回null。

  • first_id: string

  • has_more: boolean

  • last_id: string

  • object: string

示例

## [中文] 发送GET请求;将示例API凭证、文件或上传对象标识替换为应用使用的值。
curl https://api.openai.com/v1/files \
    -H "Authorization: Bearer $OPENAI_API_KEY"

响应

中文说明:以下为原文配置、命令或事件示例,字段名、枚举、标识符及数值保留。

{
  "data": [
    {
      "id": "id",
      "bytes": 0,
      "created_at": 0,
      "filename": "filename",
      "object": "file",
      "purpose": "assistants",
      "status": "uploaded",
      "expires_at": 0,
      "status_details": "status_details"
    }
  ],
  "first_id": "file-abc123",
  "has_more": false,
  "last_id": "file-abc456",
  "object": "list"
}

示例

## [中文] 发送GET请求;将示例API凭证、文件或上传对象标识替换为应用使用的值。
curl https://api.openai.com/v1/files \
  -H "Authorization: Bearer $OPENAI_API_KEY"

响应

中文说明:以下为原文配置、命令或事件示例,字段名、枚举、标识符及数值保留。

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 175,
      "created_at": 1613677385,
      "expires_at": 1677614202,
      "filename": "salesOverview.pdf",
      "purpose": "assistants",
      "status": "processed"
    },
    {
      "id": "file-abc456",
      "object": "file",
      "bytes": 140,
      "created_at": 1613779121,
      "expires_at": 1677614202,
      "filename": "puppy.jsonl",
      "purpose": "fine-tune",
      "status": "processed"
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc456",
  "has_more": false
}
OpenAI 删除文件接口
OpenAI 获取文件接口
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

其他能力与进阶指南

Embeddings 接口参考

审计日志接口参考

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }