> For the complete documentation index, see [llms.txt](https://docs.cherryai.com.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cherryai.com.cn/docs/en-us/pre-basic/providers/azure-openai.md).

# Azure OpenAI

Azure OpenAI is Microsoft's OpenAI model service hosted on Azure, suitable for teams that need enterprise compliance, data residency commitments, or the Microsoft ecosystem.

## Prerequisites

* Azure subscription activated
* Applied for and approved for Azure OpenAI Service access in Azure Portal
* Created at least one **resource (Resource)** and **deployment (Deployment)**

## Get API Key

* Azure Portal → Your Azure OpenAI resource → `Keys and Endpoint`
* Copy `KEY 1` or `KEY 2`, note down `Endpoint`(in the form of `https://<your-name>.openai.azure.com/`)

## Configure in Cherry Studio

* After enabling it `Settings → Model Services`, find **Azure OpenAI** Provider to enter the details page
* **API key**: enter the copied KEY
* **API address**: enter the resource Endpoint (no trailing path required)
* **API Version**: in the dedicated field, enter your deployment's API version (for example `2024-08-01-preview`)
* Click **Get model list**, or manually add the model name you have deployed on Azure (i.e., Deployment Name, not the original OpenAI model ID)

{% hint style="warning" %}
**Deployment Name vs Model ID**: Azure uses the name you gave the deployment (e.g. `gpt-4o-prod`), not `gpt-4o` original ID like this. Entering the wrong one will cause a 404.
{% endhint %}

## Recommended usage

* **gpt-4o / gpt-4o-mini**: general chat, Agent
* **gpt-4 turbo**: long context
* **text-embedding-3-**\*: embedding models, can be used for knowledge bases

## Frequently asked questions

* **401 Unauthorized**: check whether the Key is correct and whether there is an extra slash at the end of the Endpoint
* **404 Not Found**: check whether Deployment Name matches Azure, and whether API Version has been filled in
* **429 Throttled**: check Azure quota (Quota & Limits page)

***

### Get help and submit feedback

If you encounter any questions or bugs during configuration or use, or have suggestions for feature improvements, please refer to the official channels provided in [Feedback and Suggestions](/docs/en-us/question-contact/suggestions.md) .


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.cherryai.com.cn/docs/en-us/pre-basic/providers/azure-openai.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.