From da0b6f0cb572ecbe120f96365e121dcc3e5bde61 Mon Sep 17 00:00:00 2001 From: chenxizhang Date: Sun, 23 Jun 2024 08:50:11 +0800 Subject: [PATCH] Update README.md It is better to have the instructions for `Azure OpenAI Service` configuration. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cb2b551..666dc690 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,23 @@ cd openai-assistants-quickstart ```shell export OPENAI_API_KEY="sk_..." ``` - (or in `.env.example` and rename it to `.env`). +> [!TIP] +> If you are using `Azure OpenAI Service`, you might need the additional steps to set up your environments. Please goto to the `openai.ts` under `app` folder, and modify your code like below. Please note, you must have the `/openai` suffix in the baseURL property. + +``` +import { AzureOpenAI } from "openai"; + +export const openai = new AzureOpenAI({ + apiKey: process.env.OPENAI_API_KEY, + deployment: "gpt-4o", + apiVersion: "2024-05-01-preview", + baseURL: 'https://domorewithless-eastus.openai.azure.com/openai', +}) +``` + + ### 3. Install dependencies ```shell