doc: azure openai (#594)

#583
pingcap · Jan 16, 2025 · 677266b · 677266b
1 parent 8cff7e5
commit 677266b
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 1 deletion.
diff --git a/frontend/app/src/pages/docs/embedding-model.mdx b/frontend/app/src/pages/docs/embedding-model.mdx
@@ -172,6 +172,35 @@ Gitee AI is a third-party model provider that offers ready-to-use cutting-edge m
 
 For more information, see the [Gitee AI embedding models documentation](https://ai.gitee.com/docs/openapi/v1#tag/%E7%89%B9%E5%BE%81%E6%8A%BD%E5%8F%96/POST/embeddings).
 
+### Azure OpenAI
+
+Azure OpenAI is a cloud-based AI service that provides a OpenAI-like API on Azure.
+
+**Supported Models**:
+
+| Embedding Model          | Vector Dimensions | Max Tokens |
+| ------------------------ | ----------------- | ---------- |
+| `text-embedding-3-small` | 1536              | 8191       |
+
+For more information, see:
+
+- [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference)
+- [Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal)
+
+After creating the Azure OpenAI Service resource, you can configure the API base URL in the **Advanced Settings**:
+
+```json
+{
+  "azure_endpoint": "https://<your-resource-name>.openai.azure.com/",
+  "api_version": "<your-api-version>"
+}
+```
+
+You can find those parameters in the [Deployment Tab](https://ai.azure.com/resource/deployments) of your Azure OpenAI Service resource.
+
+![Azure OpenAI Service Deployment Tab - Embedding](https://github.com/user-attachments/assets/af8ab2b7-0f2f-40ef-86ee-124bad2d9598)
+
+
 ### Local Embedding Server
 
 Autoflow's local embedding server is a self-hosted embedding service built upon [sentence-transformers](https://www.sentence-transformers.org/) and deployed on your own infrastructure.

diff --git a/frontend/app/src/pages/docs/llm.mdx b/frontend/app/src/pages/docs/llm.mdx
@@ -126,5 +126,31 @@ Default config:
     "api_base": "http://localhost:9997/v1/"
 }
 ```
-
 To learn more about Xinference, please visit [Xinference](https://inference.readthedocs.io/en/latest/).
+
+
+#### Azure OpenAI
+
+To learn more about Azure OpenAI, please visit:
+
+- [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference)
+- [Create and deploy an Azure OpenAI Service resource](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal)
+
+After creating the Azure OpenAI Service resource, you can configure the API base URL in the **Advanced Settings**:
+
+```json
+{
+  "azure_endpoint": "https://<your-resource-name>.openai.azure.com/",
+  "api_version": "<your-api-version>",
+  "engine": "<your-deployment-name>"
+}
+```
+
+You can find those parameters in the [Deployment Tab](https://ai.azure.com/resource/deployments) of your Azure OpenAI Service resource.
+
+<Callout>
+Do not mix `Model version` and `API version` up, they are different.
+</Callout>
+
+![Azure OpenAI Service Deployment Tab - LLM](https://github.com/user-attachments/assets/158f845c-5f38-40d7-b66a-8528d7df178e)
+