来源:chatgpt官方开发文档
来源 https://chatgpt.cadn
开发人员快速入门
了解如何发出您的第一个 API 请求。OpenAI API 为最先进的 AI 模型提供了一个简单的接口,用于自然语言处理、图像生成、语义搜索和语音识别。按照本指南了解如何生成对自然语言提示的类似人类的响应,创建用于语义搜索的向量嵌入,以及从文本描述生成图像。
创建和导出 API 密钥
在此处的控制面板中创建一个 API 密钥,您将使用该密钥安全地访问 API。将密钥存储在安全的位置,例如计算机上的 .zshrc 文件或其他文本文件。生成 API 密钥后,将其作为环境变量导出到终端中。
macOS / LinuxWindows 在 macOS 或 Linux 系统上导出环境变量<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-bash"><code><span style="color:var(--text-disabled)">1
</span></code><span style="color:var(--syntax1)">export</span> OPENAI_API_KEY=<span style="color:var(--syntax3)">"your_api_key_here"</span></code></span></span></span>
发出您的第一个 API 请求
将 OpenAI API 密钥导出为环境变量后,您就可以发出第一个 API 请求了。您可以直接将 REST API 与您选择的 HTTP 客户端一起使用,也可以使用我们的官方 SDK 之一,如下所示。
JavaScript (英语)Pythoncurl要在 Node.js、Deno 或 Bun 等服务器端 JavaScript 环境中使用 OpenAI API,您可以使用适用于 TypeScript 和 JavaScript 的官方 OpenAI SDK。首先使用 npm 或首选包管理器安装 SDK:
使用 npm 安装 OpenAI SDK<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-bash"><code><span style="color:var(--text-disabled)">1
</span></code>npm install openai</code></span></span></span>
安装 OpenAI SDK 后,创建一个名为 的文件,并将以下示例之一复制到其中:example.mjs
<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-javascript"><code><span style="color:var(--text-disabled)">1
</span><span style="color:var(--text-disabled)">2
</span><span style="color:var(--text-disabled)">3
</span><span style="color:var(--text-disabled)">4
</span><span style="color:var(--text-disabled)">5
</span><span style="color:var(--text-disabled)">6
</span><span style="color:var(--text-disabled)">7
</span><span style="color:var(--text-disabled)">8
</span><span style="color:var(--text-disabled)">9
</span><span style="color:var(--text-disabled)">10
</span><span style="color:var(--text-disabled)">11
</span><span style="color:var(--text-disabled)">12
</span><span style="color:var(--text-disabled)">13
</span><span style="color:var(--text-disabled)">14
</span><span style="color:var(--text-disabled)">15
</span></code><span style="color:var(--syntax2)">import</span> OpenAI <span style="color:var(--syntax2)">from</span> <span style="color:var(--syntax3)">"openai"</span>;
<span style="color:var(--syntax2)">const</span> openai = <span style="color:var(--syntax2)">new</span> OpenAI();
<span style="color:var(--syntax2)">const</span> completion = <span style="color:var(--syntax2)">await</span> openai.chatpletions.create({
<span style="color:var(--syntax4)">model</span>: <span style="color:var(--syntax3)">"gpt-4o-mini"</span>,
<span style="color:var(--syntax4)">messages</span>: [
{ <span style="color:var(--syntax4)">role</span>: <span style="color:var(--syntax3)">"system"</span>, <span style="color:var(--syntax4)">content</span>: <span style="color:var(--syntax3)">"You are a helpful assistant."</span> },
{
<span style="color:var(--syntax4)">role</span>: <span style="color:var(--syntax3)">"user"</span>,
<span style="color:var(--syntax4)">content</span>: <span style="color:var(--syntax3)">"Write a haiku about recursion in programming."</span>,
},
],
});
<span style="color:var(--syntax1)">console</span>.log(completion.choices[<span style="color:var(--syntax4)">0</span>].message);</code></span></span></span>
执行代码 (或 Deno 或 Bun 的等效命令)。片刻之后,您应该会看到 API 请求的输出!node example.mjs
后续步骤
现在,您已经发出了第一个 OpenAI API 请求,您可以探索以下资源:
聊天完成详细了解如何生成对自然语言提示的文本响应
图像生成使用我们的 DALL·E 型
Embeddings创建文本的矢量表示形式,用于相似性搜索
文本转语音使用我们的文本转语音模型生成类似人类的录音
语音转文本使用我们的 Whisper 模型创建录音的转录
评审使用我们的审核模型分析和筛选用户创建的内容
微调使用您自己的数据微调我们的模型
Batch异步作业的批量请求
完整的 API 参考查看 OpenAI 的完整 REST API 参考
来源:chatgpt官方开发文档
来源 https://chatgpt.cadn
开发人员快速入门
了解如何发出您的第一个 API 请求。OpenAI API 为最先进的 AI 模型提供了一个简单的接口,用于自然语言处理、图像生成、语义搜索和语音识别。按照本指南了解如何生成对自然语言提示的类似人类的响应,创建用于语义搜索的向量嵌入,以及从文本描述生成图像。
创建和导出 API 密钥
在此处的控制面板中创建一个 API 密钥,您将使用该密钥安全地访问 API。将密钥存储在安全的位置,例如计算机上的 .zshrc 文件或其他文本文件。生成 API 密钥后,将其作为环境变量导出到终端中。
macOS / LinuxWindows 在 macOS 或 Linux 系统上导出环境变量<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-bash"><code><span style="color:var(--text-disabled)">1
</span></code><span style="color:var(--syntax1)">export</span> OPENAI_API_KEY=<span style="color:var(--syntax3)">"your_api_key_here"</span></code></span></span></span>
发出您的第一个 API 请求
将 OpenAI API 密钥导出为环境变量后,您就可以发出第一个 API 请求了。您可以直接将 REST API 与您选择的 HTTP 客户端一起使用,也可以使用我们的官方 SDK 之一,如下所示。
JavaScript (英语)Pythoncurl要在 Node.js、Deno 或 Bun 等服务器端 JavaScript 环境中使用 OpenAI API,您可以使用适用于 TypeScript 和 JavaScript 的官方 OpenAI SDK。首先使用 npm 或首选包管理器安装 SDK:
使用 npm 安装 OpenAI SDK<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-bash"><code><span style="color:var(--text-disabled)">1
</span></code>npm install openai</code></span></span></span>
安装 OpenAI SDK 后,创建一个名为 的文件,并将以下示例之一复制到其中:example.mjs
<span style="color:#353740"><span style="background-color:#ffffff"><span style="color:var(--text-default)"><code class="language-javascript"><code><span style="color:var(--text-disabled)">1
</span><span style="color:var(--text-disabled)">2
</span><span style="color:var(--text-disabled)">3
</span><span style="color:var(--text-disabled)">4
</span><span style="color:var(--text-disabled)">5
</span><span style="color:var(--text-disabled)">6
</span><span style="color:var(--text-disabled)">7
</span><span style="color:var(--text-disabled)">8
</span><span style="color:var(--text-disabled)">9
</span><span style="color:var(--text-disabled)">10
</span><span style="color:var(--text-disabled)">11
</span><span style="color:var(--text-disabled)">12
</span><span style="color:var(--text-disabled)">13
</span><span style="color:var(--text-disabled)">14
</span><span style="color:var(--text-disabled)">15
</span></code><span style="color:var(--syntax2)">import</span> OpenAI <span style="color:var(--syntax2)">from</span> <span style="color:var(--syntax3)">"openai"</span>;
<span style="color:var(--syntax2)">const</span> openai = <span style="color:var(--syntax2)">new</span> OpenAI();
<span style="color:var(--syntax2)">const</span> completion = <span style="color:var(--syntax2)">await</span> openai.chatpletions.create({
<span style="color:var(--syntax4)">model</span>: <span style="color:var(--syntax3)">"gpt-4o-mini"</span>,
<span style="color:var(--syntax4)">messages</span>: [
{ <span style="color:var(--syntax4)">role</span>: <span style="color:var(--syntax3)">"system"</span>, <span style="color:var(--syntax4)">content</span>: <span style="color:var(--syntax3)">"You are a helpful assistant."</span> },
{
<span style="color:var(--syntax4)">role</span>: <span style="color:var(--syntax3)">"user"</span>,
<span style="color:var(--syntax4)">content</span>: <span style="color:var(--syntax3)">"Write a haiku about recursion in programming."</span>,
},
],
});
<span style="color:var(--syntax1)">console</span>.log(completion.choices[<span style="color:var(--syntax4)">0</span>].message);</code></span></span></span>
执行代码 (或 Deno 或 Bun 的等效命令)。片刻之后,您应该会看到 API 请求的输出!node example.mjs
后续步骤
现在,您已经发出了第一个 OpenAI API 请求,您可以探索以下资源:
聊天完成详细了解如何生成对自然语言提示的文本响应
图像生成使用我们的 DALL·E 型
Embeddings创建文本的矢量表示形式,用于相似性搜索
文本转语音使用我们的文本转语音模型生成类似人类的录音
语音转文本使用我们的 Whisper 模型创建录音的转录
评审使用我们的审核模型分析和筛选用户创建的内容
微调使用您自己的数据微调我们的模型
Batch异步作业的批量请求
完整的 API 参考查看 OpenAI 的完整 REST API 参考