了解如何使用 GPT-35-Turbo 和 GPT-4 模型

以下代码片段演示了通过聊天补全 API 使用 GPT-35-Turbo 和 GPT-4 模型的最基本方法。 如果你是第一次以编程方式使用这些模型，建议先开始学习 GPT-35-Turbo 和 GPT-4 快速入门。

GPT-4 模型目前仅按请求提供。 现有的 Azure OpenAI 客户可以通过填写此表单来申请访问权限。

import os
import openai
openai.api_type = "azure"
openai.api_version = "2023-05-15" 
openai.api_base = os.getenv("OPENAI_API_BASE")  # Your Azure OpenAI resource's endpoint value.
openai.api_key = os.getenv("OPENAI_API_KEY")

response = openai.ChatCompletion.create(
    engine="gpt-35-turbo", # The deployment name you chose when you deployed the GPT-35-Turbo or GPT-4 model.
    messages=[
        {"role": "system", "content": "Assistant is a large language model trained by OpenAI."},
        {"role": "user", "content": "Who were the founders of Microsoft?"}
    ]
)

print(response)

print(response['choices'][0]['message']['content'])

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "message": {
        "content": "The founders of Microsoft are Bill Gates and Paul Allen. They co-founded the company in 1975.",
        "role": "assistant"
      }
    }
  ],
  "created": 1679014551,
  "id": "chatcmpl-6usfn2yyjkbmESe3G4jaQR6bsScO1",
  "model": "gpt-3.5-turbo-0301",
  "object": "chat.completion",
  "usage": {
    "completion_tokens": 86,
    "prompt_tokens": 37,
    "total_tokens": 123
  }
}

每个回复都包含 finish_reason。 finish_reason 可能的值为：

• stop：API 返回了完整的模型输出。
• length：由于 max_tokens 参数或标记限制，模型输出不完整。
• content_filter：由于内容筛选器的标志，省略了内容。
• null：API 回复仍在进行中或未完成。

考虑将 max_tokens 设置为略高于正常值，例如 300 或 500。 这可确保模型在到达消息末尾之前不会停止生成文本。

与以前的 GPT-3 和 GPT-3.5 模型不同，gpt-35-turbo 模型以及 gpt-4 和 gpt-4-32k 模型将继续更新。 创建这些模型的部署时，还需要指定模型版本。

可在我们的模型页上找到这些模型的模型停用日期。

OpenAI 训练了 GPT-35-Turbo 和 GPT-4 模型，以接受对话形式的输入。 消息参数获取消息对象数组，对话按角色整理。 使用 Python API 时，将使用字典列表。

基本的聊天补全的格式如下所示：

{"role": "system", "content": "Provide some context and/or instructions to the model"},
{"role": "user", "content": "The users messages goes here"}

一个示例答案后跟一个问题的对话如下所示：

{"role": "system", "content": "Provide some context and/or instructions to the model."},
{"role": "user", "content": "Example question goes here."},
{"role": "assistant", "content": "Example answer goes here."},
{"role": "user", "content": "First question/message for the model to actually respond to."}

数组的开头包含系统角色（也称为系统消息）。 此消息提供模型的初始说明。 可以在系统角色中提供各种信息，包括：

• 助手的简要说明
• 助手的个性特征
• 你希望助手遵循的指令或规则
• 模型所需的数据或信息，例如 FAQ 中的相关问题

你可以为用例自定义系统角色，也可以仅包含基本说明。 系统角色/消息是可选的，但建议至少包含一条基本说明，以获得最佳结果。

在系统角色之后，可以在用户和助手之间加入一系列消息。

 {"role": "user", "content": "What is thermodynamics?"}

若要触发模型回复，在用户消息的末尾应提示该轮到助手回复了。 还可以在用户和助手之间加入一系列样本消息，以此进行少样本学习。

以下部分展示了可用于 GPT-35-Turbo 和 GPT-4 模型的不同提示样式的示例。 这些示例只是为了抛砖引玉，你可以尝试使用不同的提示来为自己的用例自定义行为。

如果你希望 GPT-35-Turbo 模型的行为类似于 chat.openai.com，可以使用基本系统消息，例如“助手是 OpenAI 训练的大型语言模型”。

{"role": "system", "content": "Assistant is a large language model trained by OpenAI."},
{"role": "user", "content": "Who were the founders of Microsoft?"}

对于某些场景，你可能希望向模型提供其他说明，以定义模型能够执行的操作边界。

{"role": "system", "content": "Assistant is an intelligent chatbot designed to help users answer their tax related questions.
Instructions: 
- Only answer questions related to taxes. 
- If you're unsure of an answer, you can say "I don't know" or "I'm not sure" and recommend users go to the IRS website for more information. "},
{"role": "user", "content": "When are my taxes due?"}

你还可以在系统消息中加入相关数据或信息，为模型提供额外的对话上下文。 如果只需要包含少量信息，则可以将其硬编码到系统消息中。 如果你有模型应注意的大量数据，则可以使用嵌入或 Azure 认知搜索等产品在查询时检索最相关的信息。

{"role": "system", "content": "Assistant is an intelligent chatbot designed to help users answer technical questions about Azure OpenAI Serivce. Only answer questions using the context below and if you're not sure of an answer, you can say 'I don't know'.

Context:
- Azure OpenAI Service provides REST API access to OpenAI's powerful language models including the GPT-3, Codex and Embeddings model series.
- Azure OpenAI Service gives customers advanced language AI with OpenAI GPT-3, Codex, and DALL-E models with the security and enterprise promise of Azure. Azure OpenAI co-develops the APIs with OpenAI, ensuring compatibility and a smooth transition from one to the other.
- At Microsoft, we're committed to the advancement of AI driven by principles that put people first. Microsoft has made significant investments to help guard against abuse and unintended harm, which includes requiring applicants to show well-defined use cases, incorporating Microsoft’s principles for responsible AI use."
},
{"role": "user", "content": "What is Azure OpenAI Service?"}

还可以为模型提供少样本学习的示例。 由于新的提示格式，少样本学习的方法略有变化。 现在可以在提示中加入用户和助理之间的一系列消息，作为少样本学习示例。 这些例子可以用来为常见问题设定回答，以启动模型或教它特定的行为。

这只是通过 GPT-35-Turbo 和 GPT-4 使用少样本学习的其中一个示例。 可以尝试不同的方法，看看哪种方法最适合你的用例。

{"role": "system", "content": "Assistant is an intelligent chatbot designed to help users answer their tax related questions. "},
{"role": "user", "content": "When do I need to file my taxes by?"},
{"role": "assistant", "content": "In 2023, you will need to file your taxes by April 18th. The date falls after the usual April 15th deadline because April 15th falls on a Saturday in 2023. For more details, see https://www.irs.gov/filing/individuals/when-to-file."},
{"role": "user", "content": "How can I check the status of my tax refund?"},
{"role": "assistant", "content": "You can check the status of your tax refund by visiting https://www.irs.gov/refunds"}

聊天补全 API 设计用于多回合对话，但也适用于非聊天场景。

例如，对于实体提取场景，可以使用以下提示：

{"role": "system", "content": "You are an assistant designed to extract entities from text. Users will paste in a string of text and you will respond with entities you've extracted from the text as a JSON object. Here's an example of your output format:
{
   "name": "",
   "company": "",
   "phone_number": ""
}"},
{"role": "user", "content": "Hello. My name is Robert Smith. I'm calling from Contoso Insurance, Delaware. My colleague mentioned that you are interested in learning about our comprehensive benefits policy. Could you give me a call back at (555) 346-9322 when you get a chance so we can go over the benefits?"}

到目前为止，这些示例演示了与聊天补全 API 交互的基本机制。 此示例演示如何创建对话循环以执行以下操作：

• 持续接受控制台输入，并将其正确格式化为消息列表的一部分作为用户角色内容。
• 输出恢复，这些恢复在控制台中显示，经过格式化并添加到消息列表中作为助手角色内容。

这意味着，每次提出新问题时，都会将到截至目前正在运行的对话脚本连同最新问题一起发送。 由于模型没有内存，因此需要发送包含每个新问题的更新脚本，否则模型将丢失上述问题和答案的上下文。

import os
import openai
openai.api_type = "azure"
openai.api_version = "2023-05-15" 
openai.api_base = os.getenv("OPENAI_API_BASE")  # Your Azure OpenAI resource's endpoint value .
openai.api_key = os.getenv("OPENAI_API_KEY")

conversation=[{"role": "system", "content": "You are a helpful assistant."}]

while True:
    user_input = input()      
    conversation.append({"role": "user", "content": user_input})

    response = openai.ChatCompletion.create(
        engine="gpt-3.5-turbo", # The deployment name you chose when you deployed the GPT-35-turbo or GPT-4 model.
        messages=conversation
    )

    conversation.append({"role": "assistant", "content": response["choices"][0]["message"]["content"]})
    print("\n" + response['choices'][0]['message']['content'] + "\n")

运行上面的代码时，你将看到一个空白的控制台窗口。 在窗口中输入第一个问题，然后点击 Enter 键。 回复返回后，可以重复此过程并不断提出问题。

前面的示例将一直运行，直到达到模型的标记限制。 在提出每个问题和收到答案后，messages 列表的大小都会增加。 gpt-35-turbo 的标记限制为 4096 个标记，而 gpt-4 和 gpt-4-32k 的标记限制分别为 8192 和 32768。 这些限制包括发送的消息列表和模型回复中的标记计数。 与 max_tokens 参数的值组合在一起的消息列表中的标记数必须保持在这些限制以下，否则将收到错误。

你有责任确保提示和补全操作在标记限制范围内。 这意味着，对于较长的对话，需要跟踪标记数，并仅向模型发送在限制以内的提示。

以下代码示例演示了一个简单的聊天循环示例，以及使用 OpenAI 的 tiktoken 库处理 4096 标记计数的技术。

代码需要 tiktoken 0.3.0。 如果有旧版本，请运行 pip install tiktoken --upgrade。

import tiktoken
import openai
import os

openai.api_type = "azure"
openai.api_version = "2023-05-15" 
openai.api_base = os.getenv("OPENAI_API_BASE")  # Your Azure OpenAI resource's endpoint value.
openai.api_key = os.getenv("OPENAI_API_KEY")

system_message = {"role": "system", "content": "You are a helpful assistant."}
max_response_tokens = 250
token_limit = 4096
conversation = []
conversation.append(system_message)


def num_tokens_from_messages(messages):
    encoding= tiktoken.get_encoding("cl100k_base")  #model to encoding mapping https://github.com/openai/tiktoken/blob/main/tiktoken/model.py
    num_tokens = 0
    for message in messages:
        num_tokens += 4  # every message follows <im_start>{role/name}\n{content}<im_end>\n
        for key, value in message.items():
            num_tokens += len(encoding.encode(value))
            if key == "name":  # if there's a name, the role is omitted
                num_tokens += -1  # role is always required and always 1 token
    num_tokens += 2  # every reply is primed with <im_start>assistant
    return num_tokens

while True:
    user_input = input("")     
    conversation.append({"role": "user", "content": user_input})
    conv_history_tokens = num_tokens_from_messages(conversation)

    while conv_history_tokens + max_response_tokens >= token_limit:
        del conversation[1] 
        conv_history_tokens = num_tokens_from_messages(conversation)

    response = openai.ChatCompletion.create(
        engine="gpt-35-turbo", # The deployment name you chose when you deployed the GPT-35-Turbo or GPT-4 model.
        messages=conversation,
        temperature=0.7,
        max_tokens=max_response_tokens,
    )

    conversation.append({"role": "assistant", "content": response['choices'][0]['message']['content']})
    print("\n" + response['choices'][0]['message']['content'] + "\n")

在此示例中，达到标记计数后，将移除对话脚本中最早的消息。 为提高效率，使用了 del 而不是 pop()，并且从索引 1 开始，以便始终保留系统消息，并仅删除用户/助手消息。 随着时间的推移，这种管理对话的方法可能会导致对话质量下降，因为模型将逐渐失去对话早期部分的上下文。

另一种方法是将对话持续时间限制为最大标记长度或特定回合。 在达到最大标记限制，并且若允许对话继续，模型将失去上下文后，可以提示用户需要开始新的对话，清除消息列表可启动可用标记限制满额的全新对话。

前面演示的代码的标记计数部分是其中一个 OpenAI 指南示例的简化版本。