GPT⑷ API 参考指南

ChatGPT账号购买平台发布时间：2023-09-05 浏览量：8

本参考指南当前包括的内容：

1、GPT⑷ API 要求/响应模式

2、Python示例：OpenAI Python 库和LangChain

3、为何使用GPT⑷ API

Tips:

LangChain:是一个用于构建基于大型语言模型(LLM)的利用程序的库

Postman 中要求 GPT⑷ API

GPT⑷ 的 API 要求

Endpoint

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

Headers

Content-Type: application/json

Authorization: Bearer YOUR_OPENAI_API_KEY

Body

{    "model": "gpt⑷",    "messages": [        {"role": "system", "content": "Set the behavior"},        {"role": "assistant", "content": "Provide examples"},        {"role": "user", "content": "Set the instructions"}    ],    "temperature": 0.05,    "max_tokens": 256,    "top_p": 1,    "frequency_penalty": 0,    "presence_penalty": 0}

model: 正在使用哪一个版本 (例如："gpt⑷")

messages：

system：系统消息有助于设置助手的行动。在上面的例子中，助手被唆使 “你是一个得力的助手”。
assistant：助手消息有助于存储先前的回复。这是为了延续对话，提供会话的上下文。
user：用户消息有助于指点助手。就是用户说的话，向助手提的问题。

temperature：采样温度，值介于 0 到 2 之间。值越高，输出就越随机。例如你希望对同一个问题，模型每次的回复都能有较大的差异，就能够设置为一个较高的值。该参数与 top_p 通常只建议修改其中一个。

max_tokens：官方翻译过来是。完成进程中要生成的最大令牌数，提示加上max_tokens的标记计数不能超过模型的上下文长度。大多数型号的上下文长度为2048个令牌(除支持4096的最新型号)。

max_tokens是OpenAI GPT语言模型中的一个参数，用于指定生成文本时最多可使用的标记（tokens）数。标记是将文本分割为单独的单词或符号的基本单位。因此，max_tokens参数限制了生成的文本长度。

在使用OpenAI GPT模型生成文本时，可以设置max_tokens参数以控制生成的文本长度。例如，如果将max_tokens设置为50，则生成的文本将不会超过50个标记，即50个单词或符号。如果生成的文本到达了max_tokens的限制，模型将停止生成更多的文本。

总的来讲：max_tokens就是AI回复的最大单词数量。

top_p：一种替换温度采样的方法，称为核采样。模型只斟酌具有 top_p 几率质量的 token 的结果。例如设为 0.1 模型就只斟酌构成前 10% 几率质量的 token。该参数与 temperature 通常只建议修改其中一个。

frequency_penalty：值介于 ⑵.0 到 2.0 之间。正值会根据新生成 token 在文本中的频率对其进行惩罚，从而下降模型逐字重复同一行的可能性。

presence_penalty：值介于 ⑵.0 到 2.0 之间。正值会根据会不会已出现在文本中来惩罚新生成的 token，从而鼓励模型生成新的内容，避免出现大段重复的文本。

GPT⑷ API Response

{    "id": "chatcmpl⑹viHI5cWjA8QWbeeRtZFBnYMl1EKV",    "object": "chat.completion",    "created": 1680192762,    "model": "gpt⑷-0314",    "usage": {        "prompt_tokens": 21,        "completion_tokens": 5,        "total_tokens": 26    },    "choices": [        {            "message": {                "role": "assistant",                "content": "GPT⑷ response returned here"            },            "finish_reason": "stop",            "index": 0        }    ]}

id：唯一标识符

object：chat.completion

created：时间戳

model：模型,暂时的通知,OpenAI将支持到6月14日。

usage：显示了本次调用使用了多少 token

prompt_tokens：要求参数里面含有的token数，每 750 个单词定价为0.03 美元的token数量（1000tokens）

completion_tokens：返回结果含有的token数,每 750 个单词定价为0.06 美元的token数量（1000tokens）

total_tokens：等于前两个相加的总和

choices：

message：角色（即“助理”）和内容（实际响应文本）。

finish_reason：告知我们为何助手停止生成响应。在这类情况下，它停止是由于它到达了一个自然停止点（“停止”）。有效值为stop、length、content_filter 或 null。

index：这只是一个用于跟踪响应的数字（0 表示它是第一个响应）。

Python 示例

虽然可使用上面信息向 GPT⑷ API 发出 HTTPS 要求，但建议使用官方 OpenAI 库或更进一步使用 LLM 抽象层，如 LangChain。

地址：https://colab.research.google.com/gist/IvanCampos/c3f70e58efdf012a6422f2444dc3c261/langchain-gpt⑷.ipynb#scrollTo=TjnIGuQfNvzt

用于 OpenAI Python 库和 LangChain 的 Jupyter Notebook

1、安装openai的包，它提供了与 OpenAI API 通讯的工具。

!pip install openai

2、

1）导入openai，使其在项目中可使用；

2）设置访问OpenAI API 所需的密钥。

将您的实际密钥替换“YOUR_OPENAI_API_KEY”。

3）设定模型，然后发送一个要求，让他用7个词解释为何人工智能是未来。

4）打印响应结果

import openaiopenai.api_key = "YOUR_OPENAI_API_KEY"completion = openai.ChatCompletion.create(          model="gpt⑷",           messages=[{"role": "user", "content": "in 7 words, explain why artificial intelligence is the future"}]          )print(completion.choices[0].message.content)