SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场openai-api

openai-api

编程与开发

查看项目

更新于 10-16 10:49

技能介绍

一、用途 本资料是 OpenAI API 的完整使用指南，用于指导开发者通过 OpenAI 的无状态 API 构建应用，覆盖对话生成、向量嵌入、图像生成与编辑、语音转写与合成、内容审核等能力，并同时提供 Node.js SDK 与原生 fetch 两种调用示例。

二、主要能力

  1. Chat Completions API（端点 POST /v1/chat/completions）：核心语言模型接口，支持对话式 AI、文本生成、函数调用、结构化输出与视觉能力。支持的模型包括 GPT-5 系列（gpt-5、gpt-5-mini、gpt-5-nano，2025 年 8 月发布）、GPT-4o 系列（gpt-4o、gpt-4-turbo）以及 GPT-4。请求结构包含 model、messages、reasoning_effort、verbosity、temperature、max_tokens、stream、tools 等字段。消息角色分为 system（设定行为与上下文）、user（用户输入）、assistant（模型回复）。API 为无状态，每次请求需携带完整对话历史；若需有状态对话，资料指向 openai-responses 技能。
  2. GPT-5 专有参数：reasoning_effort 控制推理深度，可取 minimal、low、medium（默认）、high；verbosity 控制输出详细程度，可取 low、medium（默认）、high。GPT-5 不支持 temperature、top_p、logprobs，也不支持跨轮次的思维链（CoT）持久化。资料建议需要 temperature/top_p/logprobs 时使用 GPT-4o 或 GPT-4 Turbo。
  3. 流式输出：通过 stream: true 启用基于 Server-Sent Events（SSE）的逐 token 输出，资料给出了 Node.js SDK 与 fetch 两种实现，并提醒处理不完整分片、[DONE] 信号、网络错误重试与非法 JSON。
  4. 函数调用（工具调用）：通过 tools 定义函数，含 name、description、parameters（JSON Schema），模型可返回 tool_calls，开发者执行函数后以 role: "tool" 与 tool_call_id 回传结果，可定义多个工具由模型选择。
  5. 结构化输出：通过 response_format 指定 json_schema（strict: true）强制 JSON Schema 校验；也支持更简单的 json_object 模式。资料提示使用 response_format 时应在提示词中包含“JSON”。
  6. 视觉能力（GPT-4o）：支持通过 URL 或 base64 data URI 传入图片，也支持一次传入多张图片进行对比。
  7. Embeddings API（端点 POST /v1/embeddings）：将文本转为高维向量，用于语义搜索、聚类、推荐与 RAG。模型包括 text-embedding-3-large（默认 3072 维，可自定义 256-3072）、text-embedding-3-small（默认 1536 维，可自定义 256-1536）以及旧版 text-embedding-ada-002（固定 1536 维）。
  8. Images API：包含 DALL-E 3 生成与 GPT-Image-1 编辑（资料标题中列出，正文部分未展开细节）。
  9. Audio API：Whisper 转写与 TTS（支持 11 种音色）。
  10. Moderation API：覆盖 11 个安全类别。

三、使用方式 安装：npm install openai@6.7.0。环境变量设置：export OPENAI_API_KEY="sk-..."，或创建 .env 文件写入 OPENAI_API_KEY=sk-...。Node.js SDK 用法为先 import OpenAI from 'openai' 并实例化，再调用 openai.chat.completions.create；fetch 方式则向 https://api.openai.com/v1/chat/completions 发送 POST 请求，请求头包含 Authorization: Bearer 与 Content-Type: application/json，请求体为 JSON 字符串。资料还给出了 Cloudflare Workers 环境变量（env.OPENAI_API_KEY）的写法。文档目录还包含错误处理、速率限制与生产最佳实践等章节（正文中未展开具体内容）。

四、适用场景 需要构建对话式应用、文本生成、语义检索与 RAG、内容聚类与推荐、图像理解、图像生成与编辑、语音转写与合成、内容安全审核的开发者场景。资料中对比指出：GPT-5 适合复杂推理、数学问题、逻辑谜题与代码生成；GPT-4o 适合视觉任务、需要 temperature 控制与多模态输入的场景。

五、限制 Chat Completions API 为无状态，需自行维护完整对话历史。GPT-5 不支持 temperature、top_p、logprobs，且不支持跨轮次 CoT 持久化，也不具备视觉能力。结构化输出在 GPT-4o 上支持最佳。流式输出需处理分片不完整与非法 JSON 等情况。关于价格、计费、速率限制的具体数值、可用地区及合规信息，资料暂未提供。