Skip to content

Commit

Permalink
fix readme (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
dillonalaird authored Jun 13, 2024
1 parent 033be62 commit a321bc6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,5 @@ You can then run Vision Agent using the Azure OpenAI models:

```python
import vision_agent as va
import vision_agent.tools as T
agent = va.agent.AzureVisionAgent()
```
16 changes: 14 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,17 +174,29 @@ ensure the documentation is in the same format above with description, `Paramete
`Returns:`, and `Example\n-------`. You can find an example use case [here](examples/custom_tools/).

### Azure Setup
If you want to use Azure OpenAI models, you can set the environment variable:
If you want to use Azure OpenAI models, you need to have two OpenAI model deployments:

1. OpenAI GPT-4o model
2. OpenAI text embedding model

<img width="1201" alt="Screenshot 2024-06-12 at 5 54 48 PM" src="https://github.com/landing-ai/vision-agent/assets/2736300/da125592-b01d-45bc-bc99-d48c9dcdfa32">

Then you can set the following environment variables:

```bash
export AZURE_OPENAI_API_KEY="your-api-key"
export AZURE_OPENAI_ENDPOINT="your-endpoint"
# The deployment name of your Azure OpenAI chat model
export AZURE_OPENAI_CHAT_MODEL_DEPLOYMENT_NAME="your_gpt4o_model_deployment_name"
# The deployment name of your Azure OpenAI text embedding model
export AZURE_OPENAI_EMBEDDING_MODEL_DEPLOYMENT_NAME="your_embedding_model_deployment_name"
```

> NOTE: make sure your Azure model deployment have enough quota (token per minute) to support it. The default value 8000TPM is not enough.
You can then run Vision Agent using the Azure OpenAI models:

```python
import vision_agent as va
import vision_agent.tools as T
agent = va.agent.AzureVisionAgent()
```

0 comments on commit a321bc6

Please sign in to comment.