Skip to content

Commit 5a0da52

Browse files
committed
change env var name scheme
1 parent 54d853f commit 5a0da52

File tree

5 files changed

+36
-36
lines changed

5 files changed

+36
-36
lines changed

articles/ai-services/speech-service/includes/quickstarts/voice-live-agents/python.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,11 @@ client = AsyncAzureVoiceLive(
162162
# This is the main function to run the Voice Live API client.
163163
def main() -> None:
164164
# Set environment variables or edit the corresponding values here.
165-
endpoint = os.environ.get("AZURE_VOICE_LIVE_ENDPOINT") or "<https://your-endpoint.azure.com/>"
165+
endpoint = os.environ.get("AZURE_VOICELIVE_ENDPOINT") or "<https://your-endpoint.azure.com/>"
166166
agent_id = os.environ.get("AI_FOUNDRY_AGENT_ID") or "<your-agent-id>"
167167
project_name = os.environ.get("AI_FOUNDRY_PROJECT_NAME") or "<your-project-name>"
168-
api_version = os.environ.get("AZURE_VOICE_LIVE_API_VERSION") or "2025-10-01"
169-
api_key = os.environ.get("AZURE_VOICE_LIVE_API_KEY") or "<your-api-key>"
168+
api_version = os.environ.get("AZURE_VOICELIVE_API_VERSION") or "2025-10-01"
169+
api_key = os.environ.get("AZURE_VOICELIVE_API_KEY") or "<your-api-key>"
170170
171171
# For the recommended keyless authentication, get and
172172
# use the Microsoft Entra token instead of api_key:
@@ -861,11 +861,11 @@ connection_queue = queue.Queue()
861861
# This is the main function to run the Voice Live API client.
862862
def main() -> None:
863863
# Set environment variables or edit the corresponding values here.
864-
endpoint = os.environ.get("AZURE_VOICE_LIVE_ENDPOINT") or "<https://your-endpoint.azure.com/>"
864+
endpoint = os.environ.get("AZURE_VOICELIVE_ENDPOINT") or "<https://your-endpoint.azure.com/>"
865865
agent_id = os.environ.get("AI_FOUNDRY_AGENT_ID") or "<your-agent-id>"
866866
agent_connection_string = os.environ.get("AI_FOUNDRY_AGENT_CONNECTION_STRING") or "<your-agent-connection-string>"
867-
api_version = os.environ.get("AZURE_VOICE_LIVE_API_VERSION") or "2025-10-01"
868-
api_key = os.environ.get("AZURE_VOICE_LIVE_API_KEY") or "<your-api-key>"
867+
api_version = os.environ.get("AZURE_VOICELIVE_API_VERSION") or "2025-10-01"
868+
api_key = os.environ.get("AZURE_VOICELIVE_API_KEY") or "<your-api-key>"
869869
870870
# For the recommended keyless authentication, get and
871871
# use the Microsoft Entra token instead of api_key:

articles/ai-services/speech-service/includes/quickstarts/voice-live-agents/resource-authentication.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Create a new file named `.env` in the folder where you want to run the code.
1111
In the `.env` file, add the following environment variables for authentication:
1212

1313
```plaintext
14-
AZURE_VOICE_LIVE_ENDPOINT=<your_endpoint>
14+
AZURE_VOICELIVE_ENDPOINT=<your_endpoint>
1515
AI_FOUNDRY_PROJECT_NAME=<your_project_name>
1616
AI_FOUNDRY_AGENT_ID=<your_agent_id>
17-
AZURE_VOICE_LIVE_API_VERSION=2025-10-01
18-
AZURE_VOICE_LIVE_API_KEY=<your_api_key> # Only required if using API key authentication
17+
AZURE_VOICELIVE_API_VERSION=2025-10-01
18+
AZURE_VOICELIVE_API_KEY=<your_api_key> # Only required if using API key authentication
1919
```
2020

2121
Replace the default values with your actual project name, agent ID, API version, and API key.
@@ -24,22 +24,22 @@ Replace the default values with your actual project name, agent ID, API version,
2424

2525
|Variable name | Value |
2626
|--------------------------|-------------|
27-
| `AZURE_VOICE_LIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
27+
| `AZURE_VOICELIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
2828
| `AI_FOUNDRY_PROJECT_NAME` | The name of your Azure AI Foundry project. |
2929
| `AI_FOUNDRY_AGENT_ID` | The ID of your Azure AI Foundry agent. |
30-
| `AZURE_VOICE_LIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
30+
| `AZURE_VOICELIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
3131

3232
Learn more about [keyless authentication](/azure/ai-services/authentication) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).
3333

3434
#### [API key](#tab/api-key)
3535

3636
|Variable name | Value |
3737
|--------------------------|-------------|
38-
| `AZURE_VOICE_LIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
38+
| `AZURE_VOICELIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
3939
| `AI_FOUNDRY_PROJECT_NAME` | The name of your Azure AI Foundry project. |
4040
| `AI_FOUNDRY_AGENT_ID` | The ID of your Azure AI Foundry agent. |
41-
| `AZURE_VOICE_LIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
42-
| `AZURE_VOICE_LIVE_API_KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
41+
| `AZURE_VOICELIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
42+
| `AZURE_VOICELIVE_API_KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
4343

4444
Learn more about [finding API keys](/azure/ai-services/cognitive-services-environment-variables) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).
4545

articles/ai-services/speech-service/includes/quickstarts/voice-live-api/csharp.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Follow these steps to create a console application and install the Speech SDK.
5050
```json
5151
{
5252
"VoiceLive": {
53-
"ApiKey": "YOUR_VOICE_LIVE_API_KEY",
53+
"ApiKey": "YOUR_VOICELIVE_API_KEY",
5454
"Endpoint": "wss://api.voicelive.com/v1",
5555
"Model": "gpt-realtime",
5656
"Voice": "en-US-Ava:DragonHDLatestNeural",
@@ -1792,7 +1792,7 @@ Follow these steps to create a console application and install the Speech SDK.
17921792
17931793
var apiKeyOption = new Option<string?>(
17941794
"--api-key",
1795-
"Azure VoiceLive API key. If not provided, will use AZURE_VOICE_LIVE_API_KEY environment variable.");
1795+
"Azure VoiceLive API key. If not provided, will use AZURE_VOICELIVE_API_KEY environment variable.");
17961796
17971797
var endpointOption = new Option<string>(
17981798
"--endpoint",
@@ -1868,7 +1868,7 @@ Follow these steps to create a console application and install the Speech SDK.
18681868
.Build();
18691869
18701870
// Override with command line values if provided
1871-
apiKey ??= configuration["VoiceLive:ApiKey"] ?? Environment.GetEnvironmentVariable("AZURE_VOICE_LIVE_API_KEY");
1871+
apiKey ??= configuration["VoiceLive:ApiKey"] ?? Environment.GetEnvironmentVariable("AZURE_VOICELIVE_API_KEY");
18721872
endpoint = configuration["VoiceLive:Endpoint"] ?? endpoint;
18731873
model = configuration["VoiceLive:Model"] ?? model;
18741874
voice = configuration["VoiceLive:Voice"] ?? voice;
@@ -1894,7 +1894,7 @@ Follow these steps to create a console application and install the Speech SDK.
18941894
if (string.IsNullOrEmpty(apiKey) && !useTokenCredential)
18951895
{
18961896
Console.WriteLine("❌ Error: No authentication provided");
1897-
Console.WriteLine("Please provide an API key using --api-key or set AZURE_VOICE_LIVE_API_KEY environment variable,");
1897+
Console.WriteLine("Please provide an API key using --api-key or set AZURE_VOICELIVE_API_KEY environment variable,");
18981898
Console.WriteLine("or use --use-token-credential for Azure authentication.");
18991899
return;
19001900
}

articles/ai-services/speech-service/includes/quickstarts/voice-live-api/python.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -586,30 +586,30 @@ The sample code in this quickstart uses either Microsoft Entra ID or an API key
586586

587587
parser.add_argument(
588588
"--api-key",
589-
help="Azure VoiceLive API key. If not provided, will use AZURE_VOICE_LIVE_API_KEY environment variable.",
589+
help="Azure VoiceLive API key. If not provided, will use AZURE_VOICELIVE_API_KEY environment variable.",
590590
type=str,
591-
default=os.environ.get("AZURE_VOICE_LIVE_API_KEY"),
591+
default=os.environ.get("AZURE_VOICELIVE_API_KEY"),
592592
)
593593

594594
parser.add_argument(
595595
"--endpoint",
596596
help="Azure VoiceLive endpoint",
597597
type=str,
598-
default=os.environ.get("AZURE_VOICE_LIVE_ENDPOINT", "wss://api.voicelive.com/v1"),
598+
default=os.environ.get("AZURE_VOICELIVE_ENDPOINT", "wss://api.voicelive.com/v1"),
599599
)
600600

601601
parser.add_argument(
602602
"--model",
603603
help="VoiceLive model to use",
604604
type=str,
605-
default=os.environ.get("AZURE_VOICE_LIVE_MODEL", "gpt-realtime"),
605+
default=os.environ.get("AZURE_VOICELIVE_MODEL", "gpt-realtime"),
606606
)
607607

608608
parser.add_argument(
609609
"--voice",
610610
help="Voice to use for the assistant",
611611
type=str,
612-
default=os.environ.get("AZURE_VOICE_LIVE_VOICE", "en-US-Ava:DragonHDLatestNeural"),
612+
default=os.environ.get("AZURE_VOICELIVE_VOICE", "en-US-Ava:DragonHDLatestNeural"),
613613
help="Voice to use for the assistant. E.g. alloy, echo, fable, en-US-AvaNeural, en-US-GuyNeural",
614614
)
615615

@@ -618,7 +618,7 @@ The sample code in this quickstart uses either Microsoft Entra ID or an API key
618618
help="System instructions for the AI assistant",
619619
type=str,
620620
default=os.environ.get(
621-
"AZURE_VOICE_LIVE_INSTRUCTIONS",
621+
"AZURE_VOICELIVE_INSTRUCTIONS",
622622
"You are a helpful AI assistant. Respond naturally and conversationally. "
623623
"Keep your responses concise but engaging.",
624624
),
@@ -644,7 +644,7 @@ The sample code in this quickstart uses either Microsoft Entra ID or an API key
644644
# Validate credentials
645645
if not args.api_key and not args.use_token_credential:
646646
print("❌ Error: No authentication provided")
647-
print("Please provide an API key using --api-key or set AZURE_VOICE_LIVE_API_KEY environment variable,")
647+
print("Please provide an API key using --api-key or set AZURE_VOICELIVE_API_KEY environment variable,")
648648
print("or use --use-token-credential for Azure authentication.")
649649
sys.exit(1)
650650

articles/ai-services/speech-service/includes/quickstarts/voice-live-api/resource-authentication.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Create a new file named `.env` in the folder where you want to run the code.
1111
In the `.env` file, add the following environment variables for authentication:
1212

1313
```plaintext
14-
AZURE_VOICE_LIVE_ENDPOINT=<your_endpoint>
15-
VOICE_LIVE_MODEL=<your_model>
16-
AZURE_VOICE_LIVE_API_VERSION=2025-10-01
17-
AZURE_VOICE_LIVE_API_KEY=<your_api_key> # Only required if using API key authentication
14+
AZURE_VOICELIVE_ENDPOINT=<your_endpoint>
15+
VOICELIVE_MODEL=<your_model>
16+
AZURE_VOICELIVE_API_VERSION=2025-10-01
17+
AZURE_VOICELIVE_API_KEY=<your_api_key> # Only required if using API key authentication
1818
```
1919

2020
Replace the default values with your actual endpoint, model, API version, and API key.
@@ -23,20 +23,20 @@ Replace the default values with your actual endpoint, model, API version, and AP
2323

2424
|Variable name | Value |
2525
|--------------------------|-------------|
26-
| `AZURE_VOICE_LIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
27-
| `AZURE_VOICE_LIVE_MODEL` | The model you want to use. For example, `gpt-4o` or `gpt-4o-mini-realtime-preview`. For more information about models availability, see the [Voice Live API overview documentation](../../../voice-live.md). |
28-
| `AZURE_VOICE_LIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
26+
| `AZURE_VOICELIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
27+
| `AZURE_VOICELIVE_MODEL` | The model you want to use. For example, `gpt-4o` or `gpt-4o-mini-realtime-preview`. For more information about models availability, see the [Voice Live API overview documentation](../../../voice-live.md). |
28+
| `AZURE_VOICELIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
2929

3030
Learn more about [keyless authentication](/azure/ai-services/authentication) and [setting environment variables](/azure/ai-services/cognitive-services-environment-variables).
3131

3232
#### [API key](#tab/api-key)
3333

3434
|Variable name | Value |
3535
|--------------------------|-------------|
36-
| `AZURE_VOICE_LIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
37-
| `AZURE_VOICE_LIVE_MODEL` | The model you want to use. For example, `gpt-4o` or `gpt-4o-mini-realtime-preview`. For more information about models availability, see the [Voice Live API overview documentation](../../../voice-live.md). |
38-
| `AZURE_VOICE_LIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
39-
| `AZURE_VOICE_LIVE_API_KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
36+
| `AZURE_VOICELIVE_ENDPOINT` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. |
37+
| `AZURE_VOICELIVE_MODEL` | The model you want to use. For example, `gpt-4o` or `gpt-4o-mini-realtime-preview`. For more information about models availability, see the [Voice Live API overview documentation](../../../voice-live.md). |
38+
| `AZURE_VOICELIVE_API_VERSION`| The API version you want to use. For example, `2025-10-01`. |
39+
| `AZURE_VOICELIVE_API_KEY` | This value can be found in the **Keys and Endpoint** section when examining your resource from the Azure portal. You can use either `KEY1` or `KEY2`.|
4040

4141
Learn more about finding API keys and setting environment variables in the [Environment variables guide](/azure/ai-services/cognitive-services-environment-variables).
4242

0 commit comments

Comments
 (0)