openai-node
官方 JavaScript / TypeScript 函式庫,專為 OpenAI API 設計。
openai-node 是什麼?
官方 JavaScript / TypeScript 函式庫,專為 OpenAI API 設計。
openai-node 概覽
這是什麼
這是 OpenAI API 的官方 JavaScript / TypeScript 函式庫。它提供從 TypeScript 或 JavaScript 方便存取 OpenAI REST API 的方式。此函式庫是根據 OpenAI 的 OpenAPI 規範所產生。
主要功能
- 提供 OpenAI Responses API 和 Chat Completions API 的存取,用於從模型生成文字。
- 支援多輪對話,並提供
toResponseInputItems()輔助函式來正規化可重播的輸出項目。 - 包含視覺能力,可使用 Responses API 分析圖片並生成關於視覺內容的文字。
- 支援工作負載身分驗證,適用於 Kubernetes、Azure 和 GCP 等安全自動化環境,使用短期令牌而非長期 API 金鑰。
- 支援 Node.js 中的 X.509 用戶端憑證工作負載身分驗證。
- 使用伺服器傳送事件 (SSE) 提供串流回應。
- 支援多種形式的檔案上傳,包括
File、fetchResponse、fs.ReadStream,以及toFile或toStreamingFile輔助函式。
使用情境
- 建立使用 OpenAI 模型生成文字的應用程式,例如聊天機器人或程式碼助手。
- 分析圖片並生成關於視覺內容的描述或答案。
- 在 Responses API 的多輪互動中管理對話歷史。
- 整合使用工作負載身分驗證的雲端環境,例如 Kubernetes、Azure 和 GCP。
- 從模型串流即時回應,用於互動式應用程式。
- 上傳檔案以用於微調模型等目的。
快速開始
shnpm install openai
授權與價格
授權為 Apache-2.0。價格類型為開源。
內容整理自該專案公開的 README 與儲存庫資訊。