OpenAI Assistants API

欢迎阅读这份有关使用 OpenAI 的 Assistant API 构建 AI Agent的综合指南。 本教程专为开发人员、AI 爱好者以及任何有兴趣利用 OpenAI 语言模型强大功能的人而设计。 Assistants API 提供了一个独特的机会，通过以动态和智能的方式与 AI 交互来创建定制的用户体验。 无论你是经验丰富的开发人员还是好奇的学习者，本指南都将引导你完成将 Assistants API 集成到项目中的基本步骤。

NSDT工具推荐： Three.js AI纹理开发包 - YOLO合成数据生成器 - GLTF/GLB在线编辑 - 3D模型格式在线转换 - 可编程3D场景编辑器 - REVIT导出3D模型插件 - 3D模型语义搜索引擎 - Three.js虚拟轴心开发包 

1、前提条件

在深入创建AI Agent之前，必须确保你拥有正确的工具和软件。 这是你需要的：

• 代码编辑器：你选择的用于编写和编辑脚本的代码编辑器。 流行的选项包括 Visual Studio Code、PyCharm 或 Sublime Text。
• Python 环境：确保你的系统上安装了 Python。 为了兼容，建议使用Python 3.6或更高版本。
• OpenAI Python 库（版本 1.3.5）：该库有助于将 OpenAI 的 API 集成到 Python 应用程序中。
• API 密钥：你将需要 OpenAI API 密钥来验证你的 API 调用。 你可以从 OpenAI API Keys 获取此密钥。 确保妥善保管此密钥，并且不要公开共享。

2、Assistant API 概述

Assistants API 是一个强大的框架，由几个关键组件组成，这些组件协同工作以促进用户与 AI 之间的交互。 了解这些组件对于有效集成至关重要：

• Assistant：助手。这是 API 的核心，是一个连接 OpenAI 模型的专用 AI。 它处理用户输入并根据启用的工具和配置的指令生成响应。
• Thread：线程。将线程视为会话或对话。 它存储用户和助手之间交换的一系列消息。 这允许在正在进行的交互中保留上下文。
• Message：消息。这些是添加到线程中的各个通信片段。 每条消息可以来自用户或助手。 虽然目前不支持图像文件，但文本通信提供了丰富的交互媒介。

交互从在线程中运行Assistant开始，根据用户的输入和助手的配置触发响应。 随着我们的继续，你将学习如何设置这些组件并创建一个功能性人工智能代理。

3、搭建开发环境

首先，你需要通过安装必要的库来设置开发环境。 此设置将为你提供构建和运行 AI 代理所需的工具：

• 安装所需的库：打开命令行界面并通过运行以下命令安装 OpenAI Python 库、python-dotenv 和 colorama：
• bash
• pip install openai python-dotenv colorama
• openai：这是允许你将 OpenAI 的 API 集成到 Python 应用程序中的主要库。
• python-dotenv：该库用于管理和加载环境变量，这对于安全处理 API 密钥特别有用。
• colorama：虽然与 API 没有直接关系，但 colorama 是一个用于生成彩色终端文本的流行库，它可以增强脚本的可用性。
• 环境变量：出于安全原因，最佳实践是将 OpenAI API 密钥存储在环境变量中。 在项目目录中创建一个 .env 文件并添加 API 密钥，如下所示：

OPENAI_API_KEY='your_api_key_here'

• 使用 python-dotenv 库在脚本中加载这些变量
• 完整的开发环境设置：有关更全面的设置说明，尤其是在处理更复杂的项目结构时，请参阅 OpenAI Python 库或其他 OpenAI 资源提供的自述文件。

4、构建 AI 代理

现在，让我们深入探讨本指南的核心部分——构建人工智能代理。 请按照以下步骤创建 AI 助手并与之交互：

4.1 创建助手

你需要做的第一件事是创建一个助手。 这涉及连接到语言模型、使用自定义指令设置助手的行为以及启用代码解释器等特定工具。 你可以这样做：

# Load this securely from your environment variables import openai openai.api_key = "your_api_key_here" 

assistant = openai.Assistant.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" )

4.2 创建线程

创建助手后，设置一个用于存储交互消息的线程：

thread = openai.Thread.create()

将消息添加到线程，通过向线程添加消息来开始对话。 该消息可以是一个问题或一个命令：

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

4.3 运行助手

要获得助理的响应，请运行以下线程：

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

4.4 检查运行状态

检查运行状态以确保其成功完成非常重要：

run_status = openai.Run.retrieve( 
  thread_id=thread.id, 
  run_id=run.id ) 
print(run_status.status)

当运行处于“in_progress”状态时，线程被锁定并且无法添加消息

我们不断检查运行状态，直到状态更改为“completed”

def check_status(thread_id, run_id):
    """Checks the status of a run every second until it is completed."""
    while True:
        run = client.beta.threads.runs.retrieve(thread_id=thread_id, run_id=run_id)
        print(f"Current run status: {run.status}")
        if run.status == "completed":
            # print messages

当状态变为“completed”时，就可以进入步骤 6 并显示来自线程的消息：

def check_status(thread_id, run_id):
    """Checks the status of a run every second until it is completed."""
    while True:
        run = client.beta.threads.runs.retrieve(thread_id=thread_id, run_id=run_id)
        print(f"Current run status: {run.status}")
        if run.status == "completed":
            # print messages
            messages = client.beta.threads.messages.list( thread_id=thread.id)
            for message in messages:
                print(f"{message.role}: {message.content[0].text.value}")
            continue

你还可以让助手访问工具来扩展语言模型的功能。

在接下来的部分中，我们将深入探讨如何使用代码解释器工具、处理文件注释等。

5、代码解释器工具

代码解释器（Code Interpreter）是 Assistants API 中可用的强大工具之一。 该工具允许语言模型在安全的沙盒环境中执行 Python 代码，从而扩展了语言模型的功能。

如上一节所示，在创建助手时，你可以启用代码解释器工具。 这是通过在创建助手期间将其包含在 tools参数中来完成的：

assistant = openai.Assistant.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" )

代码解释器允许你的助手执行 Python 代码、处理文件上传和下载以及以各种方式与数据交互。 这为自动化任务、处理数据和创建交互式人工智能驱动的应用程序提供了广泛的可能性。

6、使用文件注解

在某些情况下，你可能需要助手处理文件，例如从 CSV 文件读取数据或将输出保存到文件。 以下是处理文件交互的方法：

• 文件路径注解：当代码解释器工具处理文件时，它会引用文件路径作为消息中的注解（annotation）。 这些注解可用于本地下载文件。
• 检索和保存文件：要使用这些文件，你需要从线程中检索它们并将它们保存到本地系统。 这是一个执行此操作的示例函数：

def save_files_from_thread(thread_id): 
  messages = openai.Message.list(thread_id=thread_id) 
  for message in messages: 
    annotations = message.content[0].text.annotations 
    if annotations: 
      for annotation in annotations: 
        if annotation.type == 'file_path': 
          file_id = annotation.file_path.file_id 
          file_data = openai.File.retrieve(file_id) 
          with open(f"downloaded_files/{file_id}.txt", "wb") as file:   
            file.write(file_data.content) 
            print(f"File {file_id} saved successfully.")

此函数迭代消息、检查文件路径注释、检索文件并将其保存在本地。

7、结束语

将 Assistant API 与 OpenAI 的语言模型集成，开启了一个充满可能性的世界。 从自动化复杂任务到增强用户与人工智能的交互，潜在的应用是广泛而多样的。 无论是开发智能应用程序、创建交互式工具，还是探索人工智能的新领域，Assistants API 都为创新和创造力提供了强大的平台。

如果你对本教程的完整源代码感兴趣，请访问 GitHub 存储库：Assistants API Code Examples。此外，以下资源可供你进一步探索和学习：

• OpenAI API 文档：深入了解 OpenAI API 文档。
• OpenAI 助手：在 OpenAI 助手文档中了解有关助手功能的更多信息。
• YouTube 教程：视觉学习者可以从 YouTube 上提供的视频教程中受益。

---

原文链接：OpenAI Assistants API - BimAnt