Skip to content

Commit 37e00c5

Browse files
ConstantTimeclaude
andauthored
📚 docs: update Azure OpenAI documentation for new domain format support (#437)
Updated documentation to reflect changes from LibreChat PR #10355, which fixed Azure OpenAI Speech-to-Text 400 Bad Request errors by adding support for the new `.cognitiveservices.azure.com` domain format alongside the legacy `.openai.azure.com` format. Changes: - Added domain format support callouts in STT/TTS configuration documentation - Updated Azure OpenAI configuration guide with new endpoint format examples - Enhanced instanceName field descriptions across all Azure configuration docs - Updated DALL-E baseURL documentation to show both domain formats - Added examples demonstrating both legacy and new domain usage All changes maintain backward compatibility while documenting the new functionality. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent 583330e commit 37e00c5

File tree

3 files changed

+35
-5
lines changed

3 files changed

+35
-5
lines changed

‎pages/docs/configuration/azure.mdx‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ options={[
163163
Azure OpenAI Instance:
164164
<OptionTable
165165
options={[
166-
['instanceName', 'string', 'Name of the Azure OpenAI instance. This field can also support environment variable references.', 'instanceName: ${AZURE_OPENAI_INSTANCE}'],
166+
['instanceName', 'string', 'Name of the Azure OpenAI instance. This field can also support environment variable references. **Supports both domain formats**: `.openai.azure.com` (legacy) and `.cognitiveservices.azure.com` (new). You can specify either the full domain (e.g., `my-instance.cognitiveservices.azure.com`) or just the instance name (e.g., `my-instance`) for backward compatibility with the legacy `.openai.azure.com` format.', 'instanceName: ${AZURE_OPENAI_INSTANCE}'],
167167
]}
168168
/>
169169

@@ -403,6 +403,14 @@ The base URL for Azure OpenAI API requests can be dynamically configured. This i
403403

404404
LibreChat will use the baseURL field for your Azure model grouping, which can include placeholders for the Azure OpenAI API instance and deployment names.
405405

406+
<Callout type="info" title="Azure Endpoint Domain Format Support">
407+
Azure OpenAI now supports both endpoint domain formats:
408+
- **New format**: `.cognitiveservices.azure.com`
409+
- **Legacy format**: `.openai.azure.com`
410+
411+
When using `instanceName` without a full domain, the legacy `.openai.azure.com` format is applied by default. If you provide a full domain (e.g., `my-instance.cognitiveservices.azure.com`), it will be used as-is. This applies to both `instanceName` fields and `baseURL` configurations.
412+
</Callout>
413+
406414
In the configuration, the base URL can be customized like so:
407415

408416
```yaml filename="librechat.yaml"
@@ -413,9 +421,12 @@ endpoints:
413421
- group: "group-with-custom-base-url"
414422
baseURL: "https://example.azure-api.net/${INSTANCE_NAME}/${DEPLOYMENT_NAME}"
415423
416-
# OR
424+
# Legacy format (.openai.azure.com)
417425
baseURL: "https://${INSTANCE_NAME}.openai.azure.com/openai/deployments/${DEPLOYMENT_NAME}"
418426
427+
# New format (.cognitiveservices.azure.com)
428+
baseURL: "https://${INSTANCE_NAME}.cognitiveservices.azure.com/openai/deployments/${DEPLOYMENT_NAME}"
429+
419430
# Cloudflare example
420431
baseURL: "https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/azure-openai/${INSTANCE_NAME}/${DEPLOYMENT_NAME}"
421432
```
@@ -515,8 +526,8 @@ Here's the updated layout for the DALL-E configuration options:
515526
**Base URLs:**
516527
<OptionTable
517528
options={[
518-
['DALLE3_BASEURL', 'string', 'The base URL for DALL-E 3 API endpoints.','# DALLE3_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE3_DEPLOYMENT_NAME>/'],
519-
['DALLE2_BASEURL', 'string', 'The base URL for DALL-E 2 API endpoints.','# DALLE2_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE2_DEPLOYMENT_NAME>/'],
529+
['DALLE3_BASEURL', 'string', 'The base URL for DALL-E 3 API endpoints. Supports both `.openai.azure.com` (legacy) and `.cognitiveservices.azure.com` (new) domain formats.','# DALLE3_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE3_DEPLOYMENT_NAME>/\n# OR\n# DALLE3_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.cognitiveservices.azure.com/openai/deployments/<DALLE3_DEPLOYMENT_NAME>/'],
530+
['DALLE2_BASEURL', 'string', 'The base URL for DALL-E 2 API endpoints. Supports both `.openai.azure.com` (legacy) and `.cognitiveservices.azure.com` (new) domain formats.','# DALLE2_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.openai.azure.com/openai/deployments/<DALLE2_DEPLOYMENT_NAME>/\n# OR\n# DALLE2_BASEURL=https://<AZURE_OPENAI_API_INSTANCE_NAME>.cognitiveservices.azure.com/openai/deployments/<DALLE2_DEPLOYMENT_NAME>/'],
520531
]}
521532
/>
522533

‎pages/docs/configuration/librechat_yaml/object_structure/azure_openai.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,15 +115,18 @@ apiKey: "${WESTUS_API_KEY}"
115115
**Key:**
116116
<OptionTable
117117
options={[
118-
['instanceName', 'String', 'Name of the Azure instance.', 'It\'s recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`'],
118+
['instanceName', 'String', 'Name of the Azure instance. **Supports both domain formats**: `.openai.azure.com` (legacy) and `.cognitiveservices.azure.com` (new). You can specify either the full domain (e.g., `my-instance.cognitiveservices.azure.com`) or just the instance name (e.g., `my-instance`) for backward compatibility with the legacy `.openai.azure.com` format.', 'It\'s recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`'],
119119
]}
120120
/>
121121

122122
**Required:** yes
123123

124124
**Example:**
125125
```yaml filename="endpoints / azureOpenAI / groups / {group_item} / instanceName"
126+
# Using just the instance name (legacy format applied)
126127
instanceName: "my-westus"
128+
# OR using the full domain (new format)
129+
instanceName: "my-westus.cognitiveservices.azure.com"
127130
```
128131

129132

‎pages/docs/configuration/stt_tts.mdx‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,14 @@ speech:
9393
apiVersion: 'apiVersion'
9494
```
9595
96+
<Callout type="info" title="Azure Endpoint Domain Support">
97+
The `instanceName` field supports both Azure OpenAI domain formats:
98+
- **New format**: `.cognitiveservices.azure.com` (e.g., `my-instance.cognitiveservices.azure.com`)
99+
- **Legacy format**: `.openai.azure.com` (e.g., `my-instance.openai.azure.com`)
100+
101+
You can specify either the full domain or just the instance name. If you provide a full domain including `.azure.com`, it will be used as-is. Otherwise, the legacy `.openai.azure.com` format will be applied for backward compatibility.
102+
</Callout>
103+
96104
- #### OpenAI compatible
97105

98106
Refer to the OpenAI Whisper section, adjusting the `url` and `model` as needed.
@@ -189,6 +197,14 @@ speech:
189197
voices: ['alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer']
190198
```
191199

200+
<Callout type="info" title="Azure Endpoint Domain Support">
201+
The `instanceName` field supports both Azure OpenAI domain formats:
202+
- **New format**: `.cognitiveservices.azure.com` (e.g., `my-instance.cognitiveservices.azure.com`)
203+
- **Legacy format**: `.openai.azure.com` (e.g., `my-instance.openai.azure.com`)
204+
205+
You can specify either the full domain or just the instance name. If you provide a full domain including `.azure.com`, it will be used as-is. Otherwise, the legacy `.openai.azure.com` format will be applied for backward compatibility.
206+
</Callout>
207+
192208
- #### ElevenLabs
193209

194210
```yaml

0 commit comments

Comments
 (0)