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.

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

Document format of --azure-endpoint #51

Merged
merged 1 commit into from
Jun 19, 2024
Merged

Document format of --azure-endpoint #51

Show file tree
Hide file tree
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Pass your API key to holmes with the `--api-key` cli argument:
holmes ask --api-key="..." "what pods are crashing in my cluster and why?"
```

Alternatively, you can set the OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.
If you prefer not to pass secrets on the cli, set the OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.

</details>

Expand All @@ -200,8 +200,9 @@ To work with Azure AI, you need the [Azure OpenAI](https://learn.microsoft.com/e
holmes ask "what pods are unhealthy and why?" --llm=azure --api-key=<PLACEHOLDER> --azure-endpoint='<PLACEHOLDER>'
```

Alternatively, you can set the AZURE_OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.
The `--azure-endpoint` should be a URL in the format "https://some-azure-org.openai.azure.com/openai/deployments/gpt4-1106/chat/completions?api-version=2023-07-01-preview"

If you prefer not to pass secrets on the cli, set the AZURE_OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.

</details>

Expand Down Expand Up @@ -427,7 +428,7 @@ Choose between OpenAI or Azure for integrating large language models. Provide th
```bash
# Configuration for OpenAI LLM
#llm: "openai"
#api_key: "..."
#api_key: "your-secret-api-key"
```
</details>

Expand All @@ -438,8 +439,8 @@ Choose between OpenAI or Azure for integrating large language models. Provide th
```bash
# Configuration for Azure LLM
#llm: "azure"
#api_key: "..."
#azure_endpoint: "..."
#api_key: "your-secret-api-key"
#azure_endpoint: "https://some-azure-org.openai.azure.com/openai/deployments/gpt4-1106/chat/completions?api-version=2023-07-01-preview"
```
</details>

Expand Down
2 changes: 1 addition & 1 deletion holmes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def init_logging(verbose = False):
)
opt_azure_endpoint: Optional[str] = typer.Option(
None,
help="Endpoint to use for Azure AI (if not given, uses environment variable AZURE_OPENAI_ENDPOINT)",
help="Endpoint to use for Azure AI. e.g. 'https://some-azure-org.openai.azure.com/openai/deployments/gpt4-1106/chat/completions?api-version=2023-07-01-preview'. If not given, uses environment variable AZURE_OPENAI_ENDPOINT.",
)
opt_model: Optional[str] = typer.Option("gpt-4o", help="Model to use for the LLM")
opt_config_file: Optional[Path] = typer.Option(
Expand Down
Loading