Skip to content

Update README.md - add instructions for Azure OpenAI users #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chenxizhang wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md - add instructions for Azure OpenAI users #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down