OpenAI API

OpenAI API Documentation

GPT 迭代过程

模型

OpenAI API 由具有不同功能和价位的多种模型提供支持。您还可以通过微调针对您的特定用例对我们的原始基础模型进行有限的定制。

访问我们的研究人员模型索引，详细了解我们的研究论文中介绍了哪些模型以及 InstructGPT 和 GPT-3.5 等模型系列之间的差异。

随着 的发布gpt-3.5-turbo，我们的一些模型现在正在不断更新。为了减少模型更改以意外方式影响我们用户的可能性，我们还提供将在 3 个月内保持静态的模型版本。随着模型更新的新节奏，我们还让人们能够贡献评估，以帮助我们针对不同的用例改进模型。如果您有兴趣，请查看OpenAI Evals存储库。

gpt-4或gpt-3.5-turbo。

gpt-3.5-turbo，GPT-4 针对聊天进行了优化，但也适用于使用聊天完成 API 的传统完成任务。在我们的聊天指南中了解如何使用 GPT-4 。

GPT-3.5 模型可以理解并生成自然语言或代码。我们在 GPT-3.5 系列中功能最强大且最具成本效益的模型gpt-3.5-turbo已针对聊天进行了优化，但也适用于传统的完成任务。

gpt-3.5-turbo其他 GPT-3.5 模型，因为它的成本较低。

gpt-3.5-turbo模型针对聊天进行了优化，但它非常适合传统的完成任务。原始的 GPT-3.5 模型针对文本补全进行了优化。

进行试验gpt-3.5-turbo是了解 API 功能的好方法。在您了解要实现的目标之后，您可以继续使用gpt-3.5-turbo或使用其他模型并尝试围绕其功能进行优化。

DALL·E 是一个人工智能系统，可以根据自然语言的描述创建逼真的图像和艺术作品。我们目前支持在提示的情况下创建具有特定大小的新图像、编辑现有图像或创建用户提供的图像的变体的能力。

Whisper 是一种通用的语音识别模型。它在不同音频的大型数据集上进行训练，也是一个多任务模型，可以执行多语言语音识别以及语音翻译和语言识别。Whisper v2-large 模型目前可通过我们的 API 使用whisper-1模型名称获得。

嵌入是文本的数字表示，可用于衡量两段文本之间的相关性。我们的第二代嵌入模型text-embedding-ada-002旨在以一小部分成本取代之前的 16 种第一代嵌入模型。嵌入可用于搜索、聚类、推荐、异常检测和分类任务。您可以在公告博客文章中阅读有关我们最新嵌入模型的更多信息。

审核模型接受任意大小的输入，该输入会自动分解以修复模型特定的上下文窗口。

davinci、curie、ada和babbage）是当前唯一可用于微调的模型。

他们最擅长 Python，精通 JavaScript、Go、Perl、PHP、Ruby、Swift、TypeScript、SQL 甚至 Shell 等十几种语言。

有关更多信息，请访问我们的Codex 工作指南。

API

介绍下openai api的接口入参，并说明每个参数的用法

介绍下openai api的接口返回值，并说明用法

OpenAI API的接口返回值因不同的任务和模型而异。一般而言，返回值包括以下几个字段：

id: 该请求的唯一标识符。
• object: 返回值的类型，通常为 “text_completion”，表示文本生成任务。
• created: 请求的创建时间。
• model: 使用的模型的标识符。
• choices: 一个包含所有可能输出结果的列表，每个结果包括以下字段：
• text: 模型生成的文本。
• index: 输出结果的排序位置。
• logprobs: 对于每个token，给出其概率分布及其对数概率。
• finish_reason: 完成原因。可能的值包括 “stop”，表示生成的文本达到了指定的长度或终止标记，或者 “max_turns”，表示已达到最大的文本生成轮数。
• prompt: 模型使用的输入提示。
• created: 输出结果的创建时间。 开发者可以根据自己的需求，使用返回值中的 text 字段获取模型生成的文本。同时，还可以使用 logprobs 字段获取模型对每个token的概率分布，这对于某些应用场景非常有用。

基本参数

model: 要使用的模型的 ID，访问 OpenAI Docs Models 页面可以查看全部可用的模型
• prompt: 生成结果的提示文本，即你想要得到的内容描述
• max_tokens: 生成结果时的最大 tokens 数，不能超过模型的上下文长度，可以把结果内容复制到 OpenAI Tokenizer 来了解 tokens 的计数方式
• temperature: 控制结果的随机性，如果希望结果更有创意可以尝试 0.9，或者希望有固定结果可以尝试 0.0
• top_p: 一个可用于代替 temperature 的参数，对应机器学习中 nucleus sampling，如果设置 0.1 意味着只考虑构成前 10% 概率质量的 tokens

  temperature可以简单得将其理解为“熵”，控制输出的混乱程度（随机性），而top-p可以简单将其理解为候选词列表大小，控制模型所能看到的候选词的多少。实际使用中大家要多尝试不同的值，从而获得最佳输出效果。

• frequency_penalty: [控制字符的重复度] -2.0 ~ 2.0 之间的数字，正值会根据新 tokens 在文本中的现有频率对其进行惩罚，从而降低模型逐字重复同一行的可能性（以恐怖故事为例）
  • = -2.0：当早上黎明时，我发现我家现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在现在（频率最高字符是 “现”，占比 44.79%）
  • = -1.0：他总是在清晨漫步在一片森林里，每次漫游每次每次游游游游游游游游游游游游游游游游游游游游游游游游游游游游游（频率最高字符是 “游”，占比 57.69%）
  • = 0.0：当一道阴森的风吹过早晨的小餐馆时，一个被吓得发抖的人突然出现在门口，他的嘴唇上挂满血迹，害怕的店主决定给他一份早餐，却发现他的早餐里满是血渍。（频率最高字符是 “的”，占比 8.45%）
  • = 1.0：一个熟睡的女孩被一阵清冷的风吹得不由自主地醒了，她看到了早上还未到来的黑暗，周围只有像诉说厄运般狂风呼啸而过。（频率最高字符是 “的”，占比 5.45%）
  • = 2.0：每天早上，他都会在露台上坐着吃早餐。柔和的夕阳照耀下，一切看起来安详寂静。但是有一天，当他准备端起早食的时候发现胡同里清冷的风扑进了他的意识中并带来了不安全感…… （频率最高字符是 “的”，占比 4.94%）
• presence_penalty: [控制主题的重复度] -2.0 ~ 2.0 之间的数字，正值会根据到目前为止是否出现在文本中来惩罚新 tokens，从而增加模型谈论新主题的可能性（以云课堂的广告文案为例）
  -2.0：家长们，你们是否为家里的孩子学业的发展而发愁？担心他们的学习没有取得有效的提高？那么，你们可以放心，可以尝试云课堂！它是一个为从幼儿园到高中的学生提供的一个网络平台，可以有效的帮助孩子们提高学习效率，提升学习成绩，帮助他们在学校表现出色！让孩子们的学业发展更加顺利，家长们赶紧加入吧！（抓住一个主题使劲谈论）
  • -1.0：家长们，你们是否还在为孩子的学习成绩担忧？云课堂给你们带来了一个绝佳的解决方案！我们为孩子提供了专业的学习指导，从幼儿园到高中，我们都能帮助孩子们在学校取得更好的成绩！让孩子们在学习中更轻松，更有成就感！加入我们，让孩子们拥有更好的学习体验！（紧密围绕一个主题谈论）
  • 0.0：家长们，你们是否担心孩子在学校表现不佳？云课堂将帮助您的孩子更好地学习！云课堂是一个网络平台，为从幼儿园到高中的学生提供了全面的学习资源，让他们可以在学校表现出色！让您的孩子更加聪明，让他们在学校取得更好的成绩，快来云课堂吧！（相对围绕一个主题谈论）
  • 1.0：家长们，你们的孩子梦想成为最优秀的学生吗？云课堂就是你们的答案！它不仅可以帮助孩子在学校表现出色，还能够提供专业教育资源，助力孩子取得更好的成绩！让你们的孩子一路走向成功，就用云课堂！（避免一个主题谈论的太多）
  • 2.0：家长们，您有没有想过，让孩子在学校表现出色可不是一件容易的事？没关系！我们为您提供了一个优质的网络平台——云课堂！无论您的孩子是小学生、初中生还是高中生，都能够通过云课堂找到最合适的学习方法，帮助他们在学校取得优异成绩。快来体验吧！（最大程度避免谈论重复的主题）
• stop: 最大长度为 4 的字符串列表，一旦生成的 tokens 包含其中的内容，将停止生成并返回结果

//private final String path_base="https://api.openai.com/v1";
/**
 * https://platform.openai.com/docs/api-reference/
 * <p>
 * models      列出 API 中可用的各种模型，并提供有关每个模型的基本信息，例如所有者和可用性。      * https://api.openai.com/v1/models
 * completions 给定提示，模型将返回一个或多个预测完成，还可以返回每个位置的替代令牌的概率。       * https://api.openai.com/v1/completions
 * edits       给定提示和指令，模型将返回提示的编辑版本。                                       * https://api.openai.com/v1/edits
 * images/generations   创建映像,创建给定提示的图像。给定提示和/或输入图像，模型将生成一个新图像。* https://api.openai.com/v1/images/generations
 * images/edits         创建图像编辑，在给定原始图像和提示的情况下创建编辑或扩展的图像。         * https://api.openai.com/v1/images/edits
 * images/variations    创建图像变体，创建给定图像的变体。                                     * https://api.openai.com/v1/images/variations
 * Embeddings  获取给定输入的向量表示形式，机器学习模型和算法可以轻松使用该表示形式。             * https://api.openai.com/v1/embeddings
 * files       返回属于用户组织的文件列表。文件用于上传可与微调等功能一起使用的文档。             * https://api.openai.com/v1/files
 * fine-tunes  管理微调作业，以根据特定训练数据定制模型。                            * https://api.openai.com/v1/fine-tunes
 * moderations  给定输入文本，如果模型将其归类为违反 OpenAI 的内容策略，则输出。      * https://api.openai.com/v1/moderations
 * engines      提供对 API 中可用的各种引擎的访问。                                 * https://api.openai.com/v1/engines

Create completion

(/docs/api-reference/completions/create post https://api.openai.com/v1/completions Creates a completion for the provided prompt and parameters

Request body

model

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

prompt

The prompt(s to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
• Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.

suffix

The suffix that comes after a completion of inserted text.

max_tokens

The maximum number of tokens to generate in the completion.
• The token count of your prompt plus max_tokens cannot exceed the model’s context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096.

temperature

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
• We generally recommend altering this or top_p but not both.

top_p

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
• We generally recommend altering this or temperature but not both.

n

How many completions to generate for each prompt.
• Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.

stream

Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

logprobs

Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.
• The maximum value for logprobs is 5. If you need more than this, please contact us through our Help center and describe your use case.

echo

Echo back the prompt in addition to the completion

stop

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

presence_penalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics.
• See more information about frequency and presence penalties.

frequency_penalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.
• See more information about frequency and presence penalties.

best_of

Generates best_of completions server-side and returns the “best” (the one with the highest log probability per token. Results cannot be streamed.
• When used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n.
• Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.

logit_bias

Modify the likelihood of specified tokens appearing in the completion.
• Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3 to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
• As an example, you can pass {"50256": -100} to prevent the <|endoftext|> token from being generated.

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

声明：本文由用户投稿上传，本站不保证内容的真实与正确性，并且不承担相关法律责任，如有侵权请提供版权资料并联系删除！

编程笔记 » OpenAI API