Skip to content

Commit 8cafdab

Browse files
Sma1lboywsxiaoys
andauthored
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]>
1 parent 6a23fe5 commit 8cafdab

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Azure OpenAI
2+
3+
[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.
4+
5+
Please be aware that azure will be supported starting with version 0.24, which is scheduled for release by end of 01/2025
6+
7+
## Chat model
8+
9+
It supports various GPT series chat models through an Azure OpenAI-compatible API interface.
10+
11+
```toml title="~/.tabby/config.toml"
12+
[model.chat.http]
13+
kind = "azure/chat"
14+
model_name = "gpt-4o-mini"
15+
api_endpoint = "https://<resource-name>.openai.azure.com"
16+
api_key = "your-api-key"
17+
```
18+
19+
## Completion model
20+
21+
Azure OpenAI currently does not offer completion-specific API endpoints.
22+
23+
## Embeddings model
24+
25+
It supports text-embedding-3-small, text-embedding-3-large and other embedding models through an Azure OpenAI-compatible API interface.
26+
27+
```toml title="~/.tabby/config.toml"
28+
[model.embedding.http]
29+
kind = "azure/embedding"
30+
model_name = "text-embedding-3-large"
31+
api_endpoint = "https://<resource-name>.openai.azure.com"
32+
api_key = "your-api-key"
33+
```

0 commit comments

Comments
 (0)