Skip to content
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.

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

Updated docs a bit to help guide through first run experience. #46

Merged
merged 10 commits into from
Sep 18, 2024
27 changes: 20 additions & 7 deletions docs/running-deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,26 @@ make install-requirements

## Running the Simulator Locally

Before running the Azure OpenAI API Simulator you should ensure that you have set up your local config. See [Azure OpenAI API Simulator Configuration Options](./config.md) for details on how to do this.

To run the simulated API, use the following command from the repository root directory:

```console
make run-simulated-api
```
1. Before running the Azure OpenAI API Simulator you should ensure that you have set up your local config. See [Azure OpenAI API Simulator Configuration Options](./config.md) for details on how to do this.

The minimum set of environment variables you'll need in your `.env` file to run the simulator locally are as follows:

```dotenv
SIMULATOR_API_KEY=my-test-key
TEST_OPENAI_ENDPOINT=http://localhost:8000/
TEST_OPENAI_KEY=my-test-key
hannesne marked this conversation as resolved.
Show resolved Hide resolved
TEST_OPENAI_DEPLOYMENT=gpt-3.5-turbo-0613
```

2. Start the simulator by running the following command in your terminal from the repository root directory:

```console
make run-simulated-api
```

Kill the process and run the command again to restart the simulator whenever you make changes to the config.
3. Now open the [test-aoai.http](test-aoai.http) file, and send the first POST request.
hannesne marked this conversation as resolved.
Show resolved Hide resolved
4. You should receive an http `200` response with some generated completions. Check the terminal for any warnings or errors.

## Changing the Simulator Mode

Expand Down