From d097106693752f385553bed74df785ecc8e0b1a7 Mon Sep 17 00:00:00 2001 From: Del Date: Thu, 6 Jun 2024 14:27:25 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E5=9C=A8=20Node.js?= =?UTF-8?q?=20=E4=B8=AD=E4=BD=BF=E7=94=A8=E6=9C=AC=E9=A1=B9=E7=9B=AE?= =?UTF-8?q?=E7=9A=84=E8=AF=A6=E7=BB=86=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c26587c..3180cce 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ docker run -d --env-file $(pwd)/.env \ npm install mi-gpt # 安装依赖 ``` -然后，创建并启动 `MiGPT` 实例。初始化参数请看下面的[「配置参数」](#%EF%B8%8F-配置参数)章节。 +然后，创建并启动 `MiGPT` 实例。初始化参数的具体含义请看下面的[「配置参数」](#%EF%B8%8F-配置参数)章节。 ```typescript import { MiGPT } from "mi-gpt"; @@ -76,6 +76,10 @@ async function main() { main(); ``` +注意：此模式下并不会主动读取 `.env` 和 `.migpt.json` 中的配置信息，你需要自己初始化 Node 环境变量， + +并将 `.migpt.json` 中的参数作为 `MiGPT.create` 的初始化参数传入，👉 [示例代码](https://github.com/idootop/mi-gpt/blob/example/index.ts)。 + ## ⚙️ 配置参数 ### .migpt.js @@ -125,8 +129,8 @@ main(); | **OpenAI** | | | | `OPENAI_API_KEY` | OpenAI API 密钥 | `abc123` | | `OPENAI_MODEL` | 使用的 OpenAI 模型 | `gpt-4o` | -| `AZURE_OPENAI_API_KEY` | 可选，[Microsoft Azure OpenAI](https://www.npmjs.com/package/openai#microsoft-azure-openai) | `abc123` | | `OPENAI_BASE_URL` | 可选，OpenAI API BaseURL | `https://api.openai.com/v1` | +| `AZURE_OPENAI_API_KEY` | 可选，[Microsoft Azure OpenAI](https://www.npmjs.com/package/openai#microsoft-azure-openai) | `abc123` | | **提示音效（可选）** | | | | `AUDIO_SILENT` | 静音音频链接 | `"https://example.com/slient.wav"` | | `AUDIO_BEEP` | 默认提示音链接 | `"https://example.com/beep.wav"` |