openai-quickstart-node

GitHub
2.6k 2k 简单 1 次阅读 1周前MIT插件
AI 解读 由 AI 自动生成,仅供参考

openai-quickstart-node 是 OpenAI 官方提供的 Node.js 快速入门示例集合,旨在帮助开发者轻松上手 OpenAI API。它通过一系列结构清晰、即拿即用的代码范例,展示了如何利用 Node.js SDK 调用 Chat Completions(聊天补全)、Assistants(智能助手)、Fine-tuning(模型微调)、Embeddings(嵌入向量)、Moderation(内容审核)、Batch Processing(批量处理)以及 Images(图像生成)等核心功能。

对于许多想要集成 AI 能力但不知从何下手的 Node.js 开发者而言,配置环境和理解 API 调用细节往往是一道门槛。openai-quickstart-node 正好解决了这一痛点,它不仅提供了基础用法的教学,还涵盖了多轮对话、函数调用、视觉输入等进阶场景,让用户能直观地看到代码如何转化为实际的 AI 应用,从而大幅降低学习成本和试错时间。

这款工具特别适合熟悉 JavaScript 或 Node.js 的后端工程师、全栈开发者以及技术原型设计者使用。无论是想快速验证一个创意想法,还是需要在生产环境中构建稳定的 AI 服务,都能从中找到参考范本。其独特的亮点在于按 API 功能分类的组织方式,以及覆盖从“创建任务”到“获取结果”的完整闭环示例,让开发者不仅能学会“怎么调”,更能理解“怎么用得好”。只需简单的几步配置,即可在本地运行这些脚本,开启高效的 AI 开发之旅。

使用场景

某电商初创团队的后端工程师正急需为平台构建一套包含智能客服、评论审核及营销图生成的自动化内容系统。

没有 openai-quickstart-node 时

  • 环境配置耗时:开发者需手动查阅分散的官方文档,反复调试 Node.js SDK 的安装版本兼容性及 API Key 的环境变量注入方式,极易因配置错误导致项目启动失败。
  • 功能开发从零开始:实现多轮对话上下文记忆、函数调用(Function Calling)或图片内容审核等复杂逻辑时,缺乏标准代码参考,必须自行摸索请求参数结构,试错成本极高。
  • 高级特性落地困难:面对微调模型训练、批量任务处理(Batch Processing)等高阶需求,由于缺少现成的示例脚本,团队往往因技术门槛过高而被迫放弃或延期开发。
  • 维护风险增加:自行编写的底层调用代码缺乏官方最佳实践指导,后续在应对 API 版本更新或异常处理时,容易引发系统不稳定。

使用 openai-quickstart-node 后

  • 极速启动项目:直接克隆仓库并运行 npm install,即可通过简单的环境变量设置立即跑通所有基础示例,将环境搭建时间从数小时缩短至几分钟。
  • 逻辑快速复用:直接参考 chat_completions/multi_turn.jsfunction_calling.js 等源码,快速集成智能客服的上下文记忆与工具调用能力,确保代码结构符合官方规范。
  • 高阶能力即刻解锁:利用 fine_tuningbatch 目录下的现成脚本,轻松定制专属行业模型并高效处理海量数据,大幅降低高级 AI 功能的实施难度。
  • 全场景覆盖无忧:从文本生成到 moderation/images.js 的图文合规检测,再到 DALL-E 绘图,一套库覆盖所有业务需求,显著提升开发效率与系统稳定性。

openai-quickstart-node 将复杂的 API 集成转化为标准化的“乐高积木”,让开发者能专注于业务逻辑创新而非底层连接调试。

运行环境要求

操作系统
  • Linux
  • macOS
  • Windows
GPU

未说明

内存

未说明

依赖
notes本项目为 Node.js 示例集合,无需 GPU。运行前需配置 OpenAI API Key 到环境变量 (OPENAI_API_KEY)。支持通过 Bash (Mac/Linux) 或 PowerShell (Windows) 设置环境变量。
python不适用 (基于 Node.js)
nodejs>=16.0.0
npm
openai
openai-quickstart-node hero image

快速开始

OpenAI API 快速入门 - Node.js

此仓库提供了一系列示例,演示如何使用 Node.js SDK 调用 OpenAI 的各项 API。

示例按 API 分类,每个文件夹对应一个特定的 API:

  • 对话补全
  • 助手
  • 微调
  • 嵌入
  • 内容审核
  • 批量处理
  • 图像

在每个文件夹中,您都会找到一个基础示例以帮助您快速上手。对于某些 API,还提供了更多示例,用于探索更高级的用例。

先决条件

要使用 Node.js SDK 运行这些示例,您需要:

  • 最新版本的 [Node.js](>= 16.0.0)
  • 最新版本的 [npm] 或其他 Node 包管理器
  • OpenAI API 密钥(您可以在您的 OpenAI 控制台 中获取)

使用方法

  1. 克隆此仓库

    $ git clone https://github.com/openai/openai-quickstart-node.git
    
  2. 进入项目目录

    $ cd openai-quickstart-node
    
  3. 安装 OpenAI Node.js SDK

    $ npm install openai
    
  4. 在环境变量中设置您的 OpenAI API 密钥

    在终端会话中:

    Bash(Mac/Linux):

    $ export OPENAI_API_KEY=<your-api-key>
    

    PowerShell(Windows):

    $ setx OPENAI_API_KEY "<your_api_key>"
    

    全局设置:

    将以下行添加到 Mac/Linux 系统的 .bashrc.zshrc 文件中:

    $ export OPENAI_API_KEY=<your-api-key>
    

    或者在 Windows 上更新系统环境变量。

  5. 单独运行每个脚本

    $ node path/to/script.js
    

    例如,要运行基本的对话补全示例:

    $ node chat_completions/index.js
    

示例

请浏览以下示例,了解如何针对您的具体用法使用 Node.js SDK。

API 示例 路径
对话补全 基础示例 chat_completions/index.js
多轮对话 chat_completions/multi_turn.js
函数调用 chat_completions/function_calling.js
视觉输入(图像) chat_completions/vision.js
助手 创建助手 assistants/index.js
示例线程 assistants/thread.js {assistant-id}
微调 创建微调模型 fine_tuning/index.js
使用微调模型 fine_tuning/use_model.js {job-id}
嵌入 生成嵌入向量 embeddings/index.js
内容审核 文本审核 moderation/index.js
图像与文本审核 moderation/images.js
批量处理 创建批量任务 batch/index.js
获取批量任务结果 batch/retrieve_results.js {job-id}
图像 生成图像 images/index.js

更多资源

如需更深入的前端应用示例,包括流式响应等内容,请参阅以下资源:

常见问题

相似工具推荐

n8n

n8n 是一款面向技术团队的公平代码(fair-code)工作流自动化平台,旨在让用户在享受低代码快速构建便利的同时,保留编写自定义代码的灵活性。它主要解决了传统自动化工具要么过于封闭难以扩展、要么完全依赖手写代码效率低下的痛点,帮助用户轻松连接 400 多种应用与服务,实现复杂业务流程的自动化。 n8n 特别适合开发者、工程师以及具备一定技术背景的业务人员使用。其核心亮点在于“按需编码”:既可以通过直观的可视化界面拖拽节点搭建流程,也能随时插入 JavaScript 或 Python 代码、调用 npm 包来处理复杂逻辑。此外,n8n 原生集成了基于 LangChain 的 AI 能力,支持用户利用自有数据和模型构建智能体工作流。在部署方面,n8n 提供极高的自由度,支持完全自托管以保障数据隐私和控制权,也提供云端服务选项。凭借活跃的社区生态和数百个现成模板,n8n 让构建强大且可控的自动化系统变得简单高效。

184.7k|★★☆☆☆|今天
数据工具开发框架Agent

AutoGPT

AutoGPT 是一个旨在让每个人都能轻松使用和构建 AI 的强大平台,核心功能是帮助用户创建、部署和管理能够自动执行复杂任务的连续型 AI 智能体。它解决了传统 AI 应用中需要频繁人工干预、难以自动化长流程工作的痛点,让用户只需设定目标,AI 即可自主规划步骤、调用工具并持续运行直至完成任务。 无论是开发者、研究人员,还是希望提升工作效率的普通用户,都能从 AutoGPT 中受益。开发者可利用其低代码界面快速定制专属智能体;研究人员能基于开源架构探索多智能体协作机制;而非技术背景用户也可直接选用预置的智能体模板,立即投入实际工作场景。 AutoGPT 的技术亮点在于其模块化“积木式”工作流设计——用户通过连接功能块即可构建复杂逻辑,每个块负责单一动作,灵活且易于调试。同时,平台支持本地自托管与云端部署两种模式,兼顾数据隐私与使用便捷性。配合完善的文档和一键安装脚本,即使是初次接触的用户也能在几分钟内启动自己的第一个 AI 智能体。AutoGPT 正致力于降低 AI 应用门槛,让人人都能成为 AI 的创造者与受益者。

183.6k|★★★☆☆|今天
Agent语言模型插件

opencode

OpenCode 是一款开源的 AI 编程助手(Coding Agent),旨在像一位智能搭档一样融入您的开发流程。它不仅仅是一个代码补全插件,而是一个能够理解项目上下文、自主规划任务并执行复杂编码操作的智能体。无论是生成全新功能、重构现有代码,还是排查难以定位的 Bug,OpenCode 都能通过自然语言交互高效完成,显著减少开发者在重复性劳动和上下文切换上的时间消耗。 这款工具专为软件开发者、工程师及技术研究人员设计,特别适合希望利用大模型能力来提升编码效率、加速原型开发或处理遗留代码维护的专业人群。其核心亮点在于完全开源的架构,这意味着用户可以审查代码逻辑、自定义行为策略,甚至私有化部署以保障数据安全,彻底打破了传统闭源 AI 助手的“黑盒”限制。 在技术体验上,OpenCode 提供了灵活的终端界面(Terminal UI)和正在测试中的桌面应用程序,支持 macOS、Windows 及 Linux 全平台。它兼容多种包管理工具,安装便捷,并能无缝集成到现有的开发环境中。无论您是追求极致控制权的资深极客,还是渴望提升产出的独立开发者,OpenCode 都提供了一个透明、可信

144.3k|★☆☆☆☆|4天前
Agent插件

gemini-cli

gemini-cli 是一款由谷歌推出的开源 AI 命令行工具,它将强大的 Gemini 大模型能力直接集成到用户的终端环境中。对于习惯在命令行工作的开发者而言,它提供了一条从输入提示词到获取模型响应的最短路径,无需切换窗口即可享受智能辅助。 这款工具主要解决了开发过程中频繁上下文切换的痛点,让用户能在熟悉的终端界面内直接完成代码理解、生成、调试以及自动化运维任务。无论是查询大型代码库、根据草图生成应用,还是执行复杂的 Git 操作,gemini-cli 都能通过自然语言指令高效处理。 它特别适合广大软件工程师、DevOps 人员及技术研究人员使用。其核心亮点包括支持高达 100 万 token 的超长上下文窗口,具备出色的逻辑推理能力;内置 Google 搜索、文件操作及 Shell 命令执行等实用工具;更独特的是,它支持 MCP(模型上下文协议),允许用户灵活扩展自定义集成,连接如图像生成等外部能力。此外,个人谷歌账号即可享受免费的额度支持,且项目基于 Apache 2.0 协议完全开源,是提升终端工作效率的理想助手。

100.8k|★★☆☆☆|1周前
插件Agent图像

markitdown

MarkItDown 是一款由微软 AutoGen 团队打造的轻量级 Python 工具,专为将各类文件高效转换为 Markdown 格式而设计。它支持 PDF、Word、Excel、PPT、图片(含 OCR)、音频(含语音转录)、HTML 乃至 YouTube 链接等多种格式的解析,能够精准提取文档中的标题、列表、表格和链接等关键结构信息。 在人工智能应用日益普及的今天,大语言模型(LLM)虽擅长处理文本,却难以直接读取复杂的二进制办公文档。MarkItDown 恰好解决了这一痛点,它将非结构化或半结构化的文件转化为模型“原生理解”且 Token 效率极高的 Markdown 格式,成为连接本地文件与 AI 分析 pipeline 的理想桥梁。此外,它还提供了 MCP(模型上下文协议)服务器,可无缝集成到 Claude Desktop 等 LLM 应用中。 这款工具特别适合开发者、数据科学家及 AI 研究人员使用,尤其是那些需要构建文档检索增强生成(RAG)系统、进行批量文本分析或希望让 AI 助手直接“阅读”本地文件的用户。虽然生成的内容也具备一定可读性,但其核心优势在于为机器

93.4k|★★☆☆☆|1周前
插件开发框架

ML-For-Beginners

ML-For-Beginners 是由微软推出的一套系统化机器学习入门课程,旨在帮助零基础用户轻松掌握经典机器学习知识。这套课程将学习路径规划为 12 周,包含 26 节精炼课程和 52 道配套测验,内容涵盖从基础概念到实际应用的完整流程,有效解决了初学者面对庞大知识体系时无从下手、缺乏结构化指导的痛点。 无论是希望转型的开发者、需要补充算法背景的研究人员,还是对人工智能充满好奇的普通爱好者,都能从中受益。课程不仅提供了清晰的理论讲解,还强调动手实践,让用户在循序渐进中建立扎实的技能基础。其独特的亮点在于强大的多语言支持,通过自动化机制提供了包括简体中文在内的 50 多种语言版本,极大地降低了全球不同背景用户的学习门槛。此外,项目采用开源协作模式,社区活跃且内容持续更新,确保学习者能获取前沿且准确的技术资讯。如果你正寻找一条清晰、友好且专业的机器学习入门之路,ML-For-Beginners 将是理想的起点。

85.3k|★★☆☆☆|2天前
图像数据工具视频