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

模型

列出并描述 API 中可用的各种模型。您可以参考模型文档来了解可用的模型以及它们之间的区别。source

列出模型

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

列出当前可用的模型，并提供有关每个模型的基本信息，例如所有者和可用性。source

模型对象的列表。source

示例请求

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

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

client.models.list()

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

const openai = new OpenAI();

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

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

响应

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "object": "list",
  "data": [
    {
      "id": "model-id-0",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner"
    },
    {
      "id": "model-id-1",
      "object": "model",
      "created": 1686935002,
      "owned_by": "organization-owner",
    },
    {
      "id": "model-id-2",
      "object": "model",
      "created": 1686935002,
      "owned_by": "openai"
    },
  ],
  "object": "list"
}

检索模型

获取 https://api.openai.com/v1/models/{model}

检索模型实例，提供有关模型的基本信息，例如所有者和权限。source

路径参数

MODEL

字符串source

必填

用于此请求的模型的 IDsource

与指定 ID 匹配的模型对象。source

示例请求

1
2
curl https://api.openai.com/v1/models/gpt-4o \
  -H "Authorization: Bearer $OPENAI_API_KEY"

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

client.models.retrieve("gpt-4o")

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

const openai = new OpenAI();

async function main() {
  const model = await openai.models.retrieve("gpt-4o");

  console.log(model);
}

main();

响应

1
2
3
4
5
6
{
  "id": "gpt-4o",
  "object": "model",
  "created": 1686935002,
  "owned_by": "openai"
}

删除微调模型

删除 https://api.openai.com/v1/models/{model}

删除微调的模型。您必须在组织中具有 Owner （所有者）角色才能删除模型。source

路径参数

MODEL

字符串source

必填

要删除的模型source

删除状态。source

示例请求

1
2
3
curl https://api.openai.com/v1/models/ft:gpt-4o-mini:acemeco:suffix:abc123 \
  -X DELETE \
  -H "Authorization: Bearer $OPENAI_API_KEY"

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

client.models.delete("ft:gpt-4o-mini:acemeco:suffix:abc123")

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

const openai = new OpenAI();

async function main() {
  const model = await openai.models.del("ft:gpt-4o-mini:acemeco:suffix:abc123");

  console.log(model);
}
main();

响应

1
2
3
4
5
{
  "id": "ft:gpt-4o-mini:acemeco:suffix:abc123",
  "object": "model",
  "deleted": true
}

模型对象

描述可与 API 一起使用的 OpenAI 模型产品。source

身份证

字符串source

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

创建

整数source

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

对象

字符串source

对象类型，始终为 “model”。source

owned_by

字符串source

拥有该模型的组织。source

OBJECT 模型对象

1
2
3
4
5
6
{
  "id": "gpt-4o",
  "object": "model",
  "created": 1686935002,
  "owned_by": "openai"
}

模型

列出模型

返回

检索模型

路径参数

返回

删除微调模型

路径参数

返回

模型对象