doc: Update the description of azureServiceUrl in ai-proxy README files (#2965)

This commit is contained in:
Kent Dong
2025-10-06 15:09:53 +08:00
committed by GitHub
parent 096b97e433
commit b351dc45e3
2 changed files with 18 additions and 2 deletions

View File

@@ -129,7 +129,15 @@ Azure OpenAI 所对应的 `type` 为 `azure`。它特有的配置字段如下:
| ----------------- | -------- | -------- | ------ | -------------------------------------------------------- |
| `azureServiceUrl` | string | 必填 | - | Azure OpenAI 服务的 URL须包含 `api-version` 查询参数。 |
**注意:** Azure OpenAI 只支持配置一个 API Token。
**注意:**
1. Azure OpenAI 只支持配置一个 API Token。
2. `azureServiceUrl` 支持以下三种配置格式:
1. 完整路径格式,例如:`https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-02-15-preview`
- 插件会直接将请求转发至该 URL不会参考实际的请求路径。
2. 部署名称格式,例如:`https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME?api-version=2024-02-15-preview`
- 插件会根据实际的请求路径拼接后续路径。路径中的部署名称会保留不变,不会按照模型映射规则进行修改。同时支持 URL 中不包含部署名称的接口。
3. 资源名称格式,例如:`https://YOUR_RESOURCE_NAME.openai.azure.com?api-version=2024-02-15-preview`
- 插件会根据实际的请求路径拼接后续路径。路径中的部署名称会根据请求中的模型名称结合模型映射规则进行填入。同时支持 URL 中不包含部署名称的接口。
#### 月之暗面Moonshot

View File

@@ -100,7 +100,15 @@ For Azure OpenAI, the corresponding `type` is `azure`. Its unique configuration
|---------------------|-------------|----------------------|---------------|---------------------------------------------------------------------------------------------------------------|
| `azureServiceUrl` | string | Required | - | The URL of the Azure OpenAI service, must include the `api-version` query parameter. |
**Note:** Azure OpenAI only supports configuring one API Token.
**Note:**
1. Azure OpenAI only supports configuring one API Token.
2. `azureServiceUrl` accepts three formats
1. Full URL. e.g. `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-02-15-preview`
- Request will be forwarded to the given URL, no matter what original path the request uses.
2. Resource name + deployment namee.g. `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME?api-version=2024-02-15-preview`
- The path will be updated based on the actual request path, leaving the deployment name unchanged. APIs with no deployment name in the path are also support.
3. Resource name only.e.g.`https://YOUR_RESOURCE_NAME.openai.azure.com?api-version=2024-02-15-preview`
- The path will be updated based on the actual request path. The deployment name will be filled based on the model name in the request and the configured model mapping rule. APIs with no deployment name in the path are also support.
#### Moonshot