From fabce6f823174ac7b0d62f52168978113098f4b1 Mon Sep 17 00:00:00 2001
From: constanttime <rak1729e@gmail.com>
Date: Wed, 5 Nov 2025 21:34:28 +0530
Subject: [PATCH] docs: clarify Azure instanceName format for speech services

- Add Azure OpenAI STT/TTS examples to librechat.example.yaml
- Clarify that instanceName should be the <NAME> part only (e.g., 'my-instance')
- Not the full URL (e.g., 'my-instance.cognitiveservices.azure.com')
- Add note that full domain format is still supported for backward compatibility

Examples:
- Correct: instanceName: 'my-instance'
- Also works: instanceName: 'my-instance.cognitiveservices.azure.com'

Related to #10283
---
 librechat.example.yaml | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/librechat.example.yaml b/librechat.example.yaml
index 04e088aa38..7850580946 100644
--- a/librechat.example.yaml
+++ b/librechat.example.yaml
@@ -136,6 +136,16 @@ registration:
 #       apiKey: '${TTS_API_KEY}'
 #       model: ''
 #       voices: ['']
+#     azureOpenAI:
+#       # instanceName: The <NAME> part of your Azure endpoint URL
+#       # For example, if your endpoint is: https://my-instance.cognitiveservices.azure.com
+#       # Then instanceName should be: 'my-instance' (not the full URL)
+#       instanceName: '${AZURE_TTS_INSTANCE_NAME}'
+#       apiKey: '${AZURE_TTS_API_KEY}'
+#       deploymentName: '${AZURE_TTS_DEPLOYMENT_NAME}'
+#       apiVersion: '2024-02-01'
+#       model: 'tts-1'
+#       voices: ['alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer']
 
 #
 #   stt:
@@ -143,6 +153,15 @@ registration:
 #       url: ''
 #       apiKey: '${STT_API_KEY}'
 #       model: ''
+#     azureOpenAI:
+#       # instanceName: The <NAME> part of your Azure endpoint URL
+#       # For example, if your endpoint is: https://my-instance.cognitiveservices.azure.com
+#       # Then instanceName should be: 'my-instance' (not the full URL)
+#       # Note: The code also supports full domain format for backward compatibility
+#       instanceName: '${AZURE_STT_INSTANCE_NAME}'
+#       apiKey: '${AZURE_STT_API_KEY}'
+#       deploymentName: '${AZURE_STT_DEPLOYMENT_NAME}'
+#       apiVersion: '2024-02-01'
 
 # rateLimits:
 #   fileUploads: