OpenAI Assistants API 快速入门

使用 OpenAI Assistants API 和 Next.js 的快速入门模板。

快速设置

1. 克隆仓库

git clone https://github.com/openai/openai-assistants-quickstart.git
cd openai-assistants-quickstart

2. 设置您的 OpenAI API 密钥

export OPENAI_API_KEY="sk_..."

（或在 .env.example 中设置并重命名为 .env）。

3. 安装依赖

npm install

4. 运行

npm run dev

5. 访问 http://localhost:3000。

部署

您可以将此项目部署到 Vercel 或任何支持 Next.js 的平台。

概述

本项目旨在作为在 Next.js 中使用 Assistants API 的模板，包括流式传输、工具使用（代码解释器和文件搜索）以及函数调用。虽然有多个页面展示这些功能，但它们都使用同一个启用了所有功能的底层助手。

聊天的主要逻辑可在 app/components/chat.tsx 的 Chat 组件中找到，以及以 api/assistants/threads 开头的处理程序（位于 api/assistants/threads/...）。您可以随意开始自己的项目并复制其中的一些逻辑！Chat 组件本身可以直接复制和使用，前提是您也复制了 app/components/chat.module.css 中的样式。

页面

• 基础聊天示例：http://localhost:3000/examples/basic-chat
• 函数调用示例：http://localhost:3000/examples/function-calling
• 文件搜索示例：http://localhost:3000/examples/file-search
• 全功能示例：http://localhost:3000/examples/all

主要组件

• app/components/chat.tsx - 处理聊天渲染、流式传输和函数调用转发
• app/components/file-viewer.tsx - 处理文件搜索的文件上传、获取和删除

端点

• api/assistants - POST：创建助手（仅在启动时使用）
• api/assistants/threads - POST：创建新线程
• api/assistants/threads/[threadId]/messages - POST：向助手发送消息
• api/assistants/threads/[threadId]/actions - POST：告知助手其决定调用的函数的结果
• api/assistants/files - GET/POST/DELETE：获取、上传和删除用于文件搜索的助手文件

反馈

如果您有任何想法、问题或反馈，请在此表单中告诉我们！