docs(azure-openai): add Azure OpenAI HTTP API reference documentation (…

…#3704) * docs: add Azure OpenAI HTTP API reference documentation * docs: update Azure OpenAI documentation with requirements and model name change * to: Update website/docs/references/models-http-api/azure-openai.md Co-authored-by: Meng Zhang <[email protected]> * docs: update Azure OpenAI API endpoint placeholders in documentation --------- Co-authored-by: Meng Zhang <[email protected]>
TabbyML · Jan 17, 2025 · 8cafdab · 8cafdab
1 parent 6a23fe5
commit 8cafdab
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/website/docs/references/models-http-api/azure-openai.md b/website/docs/references/models-http-api/azure-openai.md
@@ -0,0 +1,33 @@
+# Azure OpenAI
+
+[Azure OpenAI](https://azure.microsoft.com/products/ai-services/openai-service) is a cloud-based service that provides Azure customers with access to OpenAI's powerful language models including GPT-4, GPT-3.5, and various embedding models.
+
+Please be aware that azure will be supported starting with version 0.24, which is scheduled for release by end of 01/2025
+
+## Chat model
+
+It supports various GPT series chat models through an Azure OpenAI-compatible API interface.
+
+```toml title="~/.tabby/config.toml"
+[model.chat.http]
+kind = "azure/chat"
+model_name = "gpt-4o-mini"
+api_endpoint = "https://<resource-name>.openai.azure.com"
+api_key = "your-api-key"
+```
+
+## Completion model
+
+Azure OpenAI currently does not offer completion-specific API endpoints.
+
+## Embeddings model
+
+It supports text-embedding-3-small, text-embedding-3-large and other embedding models through an Azure OpenAI-compatible API interface.
+
+```toml title="~/.tabby/config.toml"
+[model.embedding.http]
+kind = "azure/embedding"
+model_name = "text-embedding-3-large"
+api_endpoint = "https://<resource-name>.openai.azure.com"
+api_key = "your-api-key"
+```