Skip to content

Commit

Permalink
chore: minor improvements to azure openai docs (#172)
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunattam authored Apr 23, 2024
1 parent 32706d5 commit 19e9531
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
21 changes: 20 additions & 1 deletion docs/models/basics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ See [dataset](../dataset/basics) to learn more about sample inputs.
| Provider | Description |
|----------|-------------|
| `openai` | All chat models are supported. Requires `OPENAI_API_KEY` environment variable. |
| `azure-openai` | All chat models from OpenAI that are hosted on Azure are supported. Requires `AZURE_OPENAI_API_KEY` and `AZURE_OPENAI_RESOURCE_NAME` environment variables. |
| `anthropic` | Claude 3 models are supported. Requires `ANTHROPIC_API_KEY` environment variable. |
| `mistral` | All chat models are supported. Requires `MISTRAL_API_KEY` environment variable. |
| `google` | Gemini Pro models are supported. Requires `GOOGLE_API_KEY` environment variable. |
| `fireworks` | Models hosted on Fireworks (e.g. `dbrx-instruct`) are supported. Requires `FIREWORKS_API_KEY` environment variable. |
| `azure-openai` | All chat models from OpenAI that are hosted on Azure are supported. Requires `AZURE_OPENAI_API_KEY` and `AZURE_OPENAI_RESOURCE_NAME` environment variables. |

<AccordionGroup>
<Accordion title="Using models from Azure OpenAI">
Expand All @@ -72,6 +72,25 @@ In the configuration file,
- Set the `provider` to `azure-openai`
- Set `model` to the name of your model deployment

#### Additional parameters

- By default, the `api-version` parameter is set to "2024-02-15-preview". If you need to override this, set the `apiVersion` parameter


```json
"runs": [
{
"type": "model",
"provider": "azure-openai",
"model": "gpt-35-deployment",
"prompt": "Hey I'm {{user_name}}",
"parameters": {
"apiVersion": "2024-02-15-preview"
}
}
]
```

</Accordion>
<Accordion title="Using models from Google">

Expand Down
2 changes: 1 addition & 1 deletion examples/spider/empiricalrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"$schema": "https://assets.empirical.run/config/schema/latest.json",
"runs": [
{
"provider": "openai",
"type": "model",
"provider": "openai",
"model": "gpt-3.5-turbo",
"prompt": "You are an SQLite expert who can convert natural language questions to SQL queries for the database schema given below.\n\nDatabase schema:\n{{schema}}\n\nAnswer the following question with only the SQL query.\n\nQuestion: {{question}}",
"scorers": [
Expand Down

0 comments on commit 19e9531

Please sign in to comment.