GPT-4 Turbo Assistants API

Assistants API

Assistants API 允许您在自己的应用程序中构建 AI 助手。助手有指令，可以利用模型、工具和知识来响应用户查询。Assistants API 目前支持三种类型的工具：代码解释器、检索和函数调用。未来，我们计划发布更多 OpenAI 构建的工具，并允许您在我们的平台上提供自己的工具。

您可以使用Assistants Playground或通过构建本指南中概述的分步集成来探索 Assistants API 的功能。从较高层面来看，Assistants API 的典型集成具有以下流程：

通过定义其自定义指令并选择模型来在 API 中创建助手。如果有帮助，请启用代码解释器、检索和函数调用等工具。
当用户开始对话时创建一个线程。
当用户提问时将消息添加到线程中。
在线程上运行助手以触发响应。这会自动调用相关工具。

本入门指南逐步介绍了创建和运行使用代码解释器的助手的关键步骤。

第 1 步：创建助手

助手代表一个实体，可以配置为使用多个参数响应用户的消息，例如：

说明：助理和模特应如何表现或回应
模型：您可以指定任何 GPT-3.5 或 GPT-4 模型，包括微调模型。检索工具需要gpt-3.5-turbo-1106和gpt-4-1106-preview模型。
工具：API 支持由 OpenAI 构建和托管的代码解释器和检索。
函数：API 允许您定义自定义函数签名，其行为与我们的函数调用功能类似。

在此示例中，我们将创建一个作为个人数学导师的助手，并启用代码解释器工具：

调用 Assistants API 要求您传递 beta HTTP 标头。如果您使用 OpenAI 的官方 Python 或 Node.js SDK，则会自动处理此问题。

text 复制代码

OpenAI-Beta: assistants=v1

升级到 Python SDK v1.2 使用 pip install --upgrade openai

python 复制代码

assistant = client.beta.assistants.create(
    name="Math Tutor",
    instructions="You are a personal math tutor. Write and run code to answer math questions.",
    tools=[{"type": "code_interpreter"}],
    model="gpt-4-1106-preview"
)

第 2 步：创建线程

一个线程代表一个对话。我们建议在用户发起对话后立即为每个用户创建一个线程。通过创建消息在此线程中传递任何特定于用户的上下文和文件。

升级到 Python SDK v1.2 使用 pip install --upgrade openai

python 复制代码

thread = client.beta.threads.create()

线程没有大小限制。您可以向线程传递任意数量的消息。API 将使用截断等相关优化技术来确保对模型的请求适合最大上下文窗口。

第 3 步：向主题添加消息

消息包含用户的文本以及用户上传的任何文件（可选）。目前不支持图像文件，但我们计划在未来几个月内添加对它们的支持。

升级到 Python SDK v1.2 使用 pip install --upgrade openai

python 复制代码

message = client.beta.threads.messages.create(
    thread_id=thread.id,
    role="user",
    content="I need to solve the equation `3x + 11 = 14`. Can you help me?"
)

现在，如果您在 Thread 中列出消息，您将看到该消息在创建时添加到线程中：

json 复制代码

{
  "object": "list",
  "data": [
    {
      "created_at": 1696995451,
      "id": "msg_4rb1Skx3XgQZEe4PHVRFQhr0",
      "object": "thread.message",
      "thread_id": "thread_34p0sfdas0823smfv",
      "role": "user",
      "content": [{
        "type": "text",
        "text": {
          "value": "I need to solve the equation `3x + 11 = 14`. Can you help me?",
          "annotations": []
        }
          }],
        ...

第四步：运行助手

为了让助手响应用户消息，您需要创建一个Run。这使得助手读取线程并决定是调用工具还是简单地使用模型来最好地回答用户查询。随着运行的进行，助手将消息附加到带有role="assistant".

您可以选择在创建运行时向助手传递附加指令：

升级到 Python SDK v1.2 使用 pip install --upgrade openai

python 复制代码

run = client.beta.threads.runs.create(
  thread_id=thread.id,
  assistant_id=assistant.id,
  instructions="Please address the user as Jane Doe. The user has a premium account."
)

#### 第 5 步：显示助理的响应 这将创建"运行"状态`queued`。您可以定期检索运行以检查其[状态](https://platform.openai.com/docs/assistants/how-it-works/run-lifecycle)，看看它是否已移至`completed`. 升级到 [Python SDK v1.2](https://github.com/openai/openai-python/tree/main#installation) 使用 pip install --upgrade openai ```python run = client.beta.threads.runs.retrieve( thread_id=thread.id, run_id=run.id ) ``` 运行完成后，您可以检索助手添加到线程的消息。 升级到 [Python SDK v1.2](https://github.com/openai/openai-python/tree/main#installation) 使用 pip install --upgrade openai ```python messages = client.beta.threads.messages.list( thread_id=thread.id ) ``` 最后，将它们显示给用户！在此运行期间，助理向线程添加了两条新消息。 | 角色 | 内容 | |-------------|------------------------------------------------------------------------------------------------------------------------------------------| | `user` | 我需要解方程`3x + 11 = 14`。你能帮助我吗？ | | `assistant` | 当然，简\cdot多伊。`(3x + 11 = 14)`要求解的方程`(x)`，您需要`(x)`在方程的一侧进行隔离。您可以按照以下方法执行此操作：1. 等式两边同时减去11，得到`(3x = 3)`。2. 然后，两边除以 3 即可解出`(x)`。`(x)`让我为您计算一下价值。 | | `assistant` | 方程的解`(3x + 11 = 14)`为`(x = 1)`。 |