fix: Azure OpenAI Service

.env.example

@@ -1,14 +1,13 @@
-# OpenAI（也支持通义千问、MoonShot、DeepSeek 等模型参数）
+# OpenAI（也支持通义千问、MoonShot、DeepSeek 等模型）
 OPENAI_MODEL=gpt-4o
 OPENAI_API_KEY=sk-xxxxxxxxxxxxxxx
 OPENAI_BASE_URL=https://api.openai.com/v1
 
-# Azure OpenAI
+# Azure OpenAI Service（可选）
-# OPENAI_API_VERSION=xxxx-xx-xx
+# OPENAI_API_VERSION=2024-04-01-preview
-# 这里要进入Azure OpenAI Studio的聊天操场，在那儿选择你想用的部署（模型），再点示例代码，看里面的api_version字段，而不是部署页面显示的模型版本
-deployment=你的部署名
-# AZURE_OPENAI_ENDPOINT=https://你的资源名.openai.azure.com
 # AZURE_OPENAI_API_KEY=你的密钥
+# AZURE_OPENAI_ENDPOINT=https://你的资源名.openai.azure.com
+# AZURE_OPENAI_DEPLOYMENT=你的模型部署名，比如：gpt-35-turbo-instruct
 
 # 提示音效（可选，一般不用填，你也可以换上自己的提示音链接试试看效果）
 # AUDIO_SILENT=静音音频链接，示例：https://example.com/slient.wav

docs/faq.md

@@ -106,6 +106,19 @@ docker run -d --env-file %cd%\.env ^
 
 </details>
 
+### Q：是否支持 Azure OpenAI，如何配置？
+
+如果你想使用 [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/ai-services/openai-service)，可通过配置以下环境变量开启：
+
+```shell
+OPENAI_API_VERSION=2024-04-01-preview
+AZURE_OPENAI_API_KEY=你的密钥
+AZURE_OPENAI_ENDPOINT=https://你的资源名.openai.azure.com
+AZURE_OPENAI_DEPLOYMENT=你的模型部署名，比如：gpt-35-turbo-instruct
+```
+
+注意：Azure OpenAI Studio 部署页面显示的模型版本号，可能并非实际的 `OPENAI_API_VERSION` 值。请打开模型 Play Ground 页面，选择你想用的部署（模型），然后点击示例代码，查看里面的 `api_version` 并替换上面的 `OPENAI_API_VERSION` 的值。
+
 ### Q：怎样使用豆包的音色
 
 此功能需要豆包 TTS 接口支持，本项目暂不对外提供此服务。

docs/todo.md

@@ -34,7 +34,8 @@
 ## ❤️ 感谢
 
 - @shaoyi1991 补充的关于项目启动和国内配置 docker 镜像的说明。 https://github.com/idootop/mi-gpt/issues/28
-- @shog86 协助调试 Azure OpenAI 相关的配置参数 https://github.com/idootop/mi-gpt/pull/34
+- @shog86 协助调试 Azure OpenAI Service 相关的配置参数 https://github.com/idootop/mi-gpt/pull/34
+- @otkHsiao 反馈 Azure OpenAI Service 配置 deployment 的问题 https://github.com/idootop/mi-gpt/pull/34#issuecomment-2156068725
 - @siseboy 提供群晖 docker 使用教程 https://github.com/idootop/mi-gpt/issues/41
 - @moffefei 提供的 Windows 下 docker 启动命令的示例 https://github.com/idootop/mi-gpt/issues/45
 

src/services/openai.ts

@@ -25,11 +25,17 @@ class OpenAIClient {
   traceOutput = true;
   private _logger = Logger.create({ tag: "Open AI" });
 
+  deployment?: string;
+
   private _client?: OpenAI;
   private _init() {
+    this.deployment = kEnvs.AZURE_OPENAI_DEPLOYMENT;
     if (!this._client) {
       this._client = kEnvs.AZURE_OPENAI_API_KEY
-        ? new AzureOpenAI({ httpAgent: kProxyAgent })
+        ? new AzureOpenAI({
+            httpAgent: kProxyAgent,
+            deployment: this.deployment,
+          })
         : new OpenAI({ httpAgent: kProxyAgent });
     }
   }
@@ -55,7 +61,7 @@ class OpenAIClient {
       jsonMode,
       requestId,
       trace = false,
-      model = kEnvs.OPENAI_MODEL ?? "gpt-4o",
+      model = this.deployment ?? kEnvs.OPENAI_MODEL ?? "gpt-4o",
     } = options;
     if (trace && this.traceInput) {
       this._logger.log(
@@ -107,7 +113,7 @@ class OpenAIClient {
       requestId,
       onStream,
       trace = false,
-      model = kEnvs.OPENAI_MODEL ?? "gpt-4o",
+      model = this.deployment ?? kEnvs.OPENAI_MODEL ?? "gpt-4o",
     } = options;
     if (trace && this.traceInput) {
       this._logger.log(

src/utils/env.ts

@@ -5,4 +5,5 @@ export const kEnvs: Partial<{
   OPENAI_MODEL: string;
   OPENAI_API_KEY: string;
   AZURE_OPENAI_API_KEY: string;
+  AZURE_OPENAI_DEPLOYMENT: string;
 }> = process.env as any;