Completions-OpenAI API系统快速入门

给定提示，模型将返回一个或多个预测完成，还可以返回每个位置的替代令牌的概率。

使用完成接口

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

此接口的作用为提供的提示和参数创建补全

Request body-请求正文

model  string  Required

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

prompt  string or array Optional Defaults to <|endoftext|>

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

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

suffix string Optional Defaults to null

完成插入文本后的后缀。

max_tokens integer Optional Defaults to 16

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

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

temperature number Optional Defaults to 1

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

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

top_p number OptionalDefaults to 1

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

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

n integer Optional Defaults to 1

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

注意：由于此参数会生成许多完成，因此它会快速消耗令牌配额。小心使用并确保您有合理的设置.max_tokensstop

stream boolean Optional Defaults to false

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

Logprobs integer Optional Defaults to null

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

最大值为 5。logprobs

Echo boolean Optional Defaults to false

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

Stop string or array OptionalDefaults to null

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

presence_penalty number Optional Defaults to 0

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

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

frequency_penalty number Optional Defaults to 0

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

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

best_ofintegerOptionalDefaults to 1

在服务器端生成完成并返回“最佳”（每个令牌的日志概率最高的那个）。无法流式传输结果.best_of与一起使用时，控制候选完成次数并指定要返回的次数 - 必须大于.n best_of n best_of n

注意：由于此参数会生成许多完成，因此它会快速消耗令牌配额。小心使用并确保您有合理的设置.max_tokens stop

logit_bias map Optional Defaults to null

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

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

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

user string Optional

代表最终用户的唯一标识符，可帮助 OpenAI 监控和检测滥用行为。

调用示例

 

curl  https://api.openai.com/v1/completions

  -H 'Content-Type: application/json'

  -H 'Authorization: Bearer YOUR_API_KEY'

  -d '{

  "model": "text-davinci-003",

  "prompt": "Say this is a test",

  "max_tokens": 7,

  "temperature": 0

}'

参数详情

 

{  "model": "text-davinci-003",  "prompt": "Say this is a test",  "max_tokens": 7,  "temperature": 0,  "top_p": 1,  "n": 1,  "stream": false,  "logprobs": null,  "stop": "\n"

}

响应

 

{  "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7",  "object": "text_completion",  "created": 1589478378,  "model": "text-davinci-003",  "choices": [

    {      "text": "\n\nThis is indeed a test",      "index": 0,      "logprobs": null,      "finish_reason": "length"

    }

  ],  "usage": {    "prompt_tokens": 5,    "completion_tokens": 7,    "total_tokens": 12

  }

}