openai-node 学习资料汇总 - 官方 Node.js/TypeScript OpenAI API 库

openai-node 简介

openai-node 是 OpenAI 官方提供的 Node.js/TypeScript API 库,用于方便地调用 OpenAI 的 REST API。该库从 OpenAI 的 OpenAPI 规范生成,提供了完整的 TypeScript 类型定义。

安装使用

可以通过 npm 安装:

npm install openai

基本使用示例:

import OpenAI from 'openai';

const openai = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'],
});

async function main() {
  const chatCompletion = await openai.chat.completions.create({
    messages: [{ role: 'user', content: 'Hello!' }],
    model: 'gpt-3.5-turbo',
  });
  
  console.log(chatCompletion.choices[0].message);
}

main();

主要功能

• 支持 OpenAI 的所有 API 功能,包括 Chat Completions、Embeddings、Fine-tuning 等
• 提供流式响应支持
• 内置请求重试、错误处理等功能
• 支持自定义 HTTP 代理
• 支持 TypeScript,提供完整类型定义

学习资源

1. 官方文档
2. GitHub 仓库
3. API 参考
4. 使用示例
5. Helpers 文档

高级用法

1. 流式响应
2. 函数调用
3. 文件上传
4. 错误处理
5. 自定义 HTTP Agent

详细用法请参考 GitHub README。

版本与兼容性

• 支持 TypeScript 4.5+
• 支持 Node.js 18+ LTS 版本
• 支持 Deno、Bun、Cloudflare Workers 等运行时

更多信息请访问 GitHub 仓库。希望本文能帮助你快速上手 openai-node 库!如有问题欢迎在 GitHub 上提 issue 反馈。

文章链接：www.dongaigc.com/a/openai-node-learning-resources

https://www.dongaigc.com/a/openai-node-learning-resources