OpenAI 接口文档-(中文版)-（一）_openai接口

pip install openai

npm install openai

Authorization: Bearer OPENAI_API_KEY

curl https://api.openai.com/v1/models \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "OpenAI-Organization: org-9IDA3AdSqPmLz47IRWkb82tK"

import os
import openai
openai.organization = "org-9IDA3AdSqPmLz47IRWkb82tK"
openai.api_key = os.getenv("OPENAI_API_KEY")
openai.Model.list()

import { Configuration, OpenAIApi } from "openai";
const configuration = new Configuration({
    organization: "org-9IDA3AdSqPmLz47IRWkb82tK",
    apiKey: process.env.OPENAI_API_KEY,
});
const openai = new OpenAIApi(configuration);
const response = await openai.listEngines();

curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
     "model": "gpt-3.5-turbo",
     "messages": [{"role": "user", "content": "Say this is a test!"}],
     "temperature": 0.7
   }'

要使用的模型的 ID。可以使用列表模型 API 查看所有可用模型，或参阅模型概述了解它们的描述。

用于生成完成、编码为字符串、字符串数组、标记数组或标记数组数组的提示。

请注意，<|endoftext|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将生成，就像从新文档的开头一样。

完成插入文本后的后缀。

完成时要生成的最大令牌数。

提示加号的令牌计数不能超过模型的上下文长度。大多数模型的上下文长度为 2048 个令牌（最新模型除外，它支持 4096）。max_tokens

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使其更加集中和确定。

我们通常建议更改此设置，但不要同时更改两者。top_p

使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。

我们通常建议更改此设置，但不要同时更改两者。temperature

为每个提示生成的完成次数。

注意：由于此参数会生成许多完成，因此它会快速消耗令牌配额。请谨慎使用，并确保对 和 进行合理的设置。max_tokensstop

是否流式传输回部分进度。如果设置，令牌将在可用时作为纯数据服务器发送的事件发送，流由消息终止。data: [DONE]

包括最可能的令牌的日志概率，以及所选令牌。例如，如果为 5，则 API 将返回 5 个最可能的令牌的列表。API 将始终返回采样令牌的 ，因此响应中最多可能有元素。logprobslogprobslogproblogprobs+1

的最大值为 5。如果您需要更多，请通过我们的帮助中心与我们联系并描述您的使用案例。logprobs

除了完成之外，还回显提示

最多 4 个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止是否出现在文本中来惩罚它们，从而增加模型讨论新主题的可能性。

查看有关频率和状态处罚的更多信息。

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记，从而降低模型逐字重复同一行的可能性。

查看有关频率和状态处罚的更多信息。

在服务器端生成完成并返回“最佳”（每个令牌的日志概率最高的那个）。无法流式传输结果。best_of

与 一起使用时，控制候选完成次数并指定要返回的完成次数 – 必须大于 。nbest_ofnbest_ofn

注意：由于此参数会生成许多完成，因此它会快速消耗令牌配额。请谨慎使用，并确保对 和 进行合理的设置。max_tokensstop

修改完成中出现指定令牌的可能性。

接受将令牌（由其在 GPT 标记器中的令牌 ID 指定）映射到 -100 到 100 之间的关联偏差值的 json 对象。您可以使用此分词器工具（适用于 GPT-2 和 GPT-3）将文本转换为令牌 ID。在数学上，偏差在采样之前被添加到模型生成的对数中。确切的效果因模型而异，但介于 -1 和 1 之间的值应降低或增加选择的可能性;像 -100 或 100 这样的值应该会导致禁止或排他性选择相关令牌。

例如，您可以传递以防止生成 <|endoftext|> 令牌。{"50256": -100}

聊天 Chat

给定聊天对话，模型将返回聊天完成响应。

POST https://api.openai.com/v1/chat/completions

curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Hello!"}]
}

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "\n\nHello there, how may I assist you today?",
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

curl https://api.openai.com/v1/edits \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "text-davinci-edit-001",
    "input": "What day of the wek is it?",
    "instruction": "Fix the spelling mistakes"
  }'

{
  "model": "text-davinci-edit-001",
  "input": "What day of the wek is it?",
  "instruction": "Fix the spelling mistakes",
}

{
  "object": "edit",
  "created": 1589478378,
  "choices": [
    {
      "text": "What day of the week is it?",
      "index": 0,
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 32,
    "total_tokens": 57
  }
}