aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristoph Vollmann <me@cvollmann.de>2025-10-26 16:09:36 +0100
committerGitHub <noreply@github.com>2025-10-26 15:09:36 +0000
commitbd9c933bc063557aa743e45b5c5d3a1947b43d46 (patch)
tree893fe31e9d488d45e0eace8fb5e4ea090141de1f /docs
parent8a330dc2da1695c6700b491c2aece9b4675e32fc (diff)
downloadkarakeep-bd9c933bc063557aa743e45b5c5d3a1947b43d46.tar.zst
docs: Add Azure configuration details for OpenAI-compatible API (#2072)
* docs: Add Azure configuration details for OpenAI-compatible API * Update docs/docs/14-guides/05-different-ai-providers.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/14-guides/05-different-ai-providers.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/docs/14-guides/05-different-ai-providers.md b/docs/docs/14-guides/05-different-ai-providers.md
index 33408c00..9a86e04f 100644
--- a/docs/docs/14-guides/05-different-ai-providers.md
+++ b/docs/docs/14-guides/05-different-ai-providers.md
@@ -64,3 +64,25 @@ OPENAI_API_KEY: Your Perplexity API Key
INFERENCE_TEXT_MODEL: sonar-pro
INFERENCE_IMAGE_MODEL: sonar-pro
```
+
+## Azure
+
+Azure has an OpenAI-compatible API.
+
+You can get your API key from the Overview page of the Azure AI Foundry Portal or via "Keys + Endpoints" on the resource in the Azure Portal.
+
+:::warning
+The [model name is the deployment name](https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/switching-endpoints#keyword-argument-for-model) you specified when deploying the model, which may differ from the base model name.
+:::
+
+```
+# Deployed via Azure AI Foundry:
+OPENAI_BASE_URL=https://{your-azure-ai-foundry-resource-name}.cognitiveservices.azure.com/openai/v1/
+
+# Deployed via Azure OpenAI Service:
+OPENAI_BASE_URL=https://{your-azure-openai-resource-name}.openai.azure.com/openai/v1/
+
+OPENAI_API_KEY=YOUR_API_KEY
+INFERENCE_TEXT_MODEL=YOUR_DEPLOYMENT_NAME
+INFERENCE_IMAGE_MODEL=YOUR_DEPLOYMENT_NAME
+```