Skip to content

Commit 2f0b2db

Browse files
authored
fix: Standardize OpenAI API key environment variable naming (#1001) (#2629)
- Replace OPENAI_APIKEY with OPENAI_API_KEY across all samples - Replace AZURE_FOUNDRY_OPENAI_APIKEY with AZURE_FOUNDRY_OPENAI_API_KEY - Ensures consistency with OpenAI's standard naming convention - Applies to .NET and Python samples Fixes #1001 Co-authored-by: Alexander Zarei <alzarei@users.noreply.github.com>
1 parent 7be860e commit 2f0b2db

File tree

15 files changed

+15
-15
lines changed

15 files changed

+15
-15
lines changed

agent-samples/openai/OpenAIAssistants.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ model:
1111
topP: 0.95
1212
connection:
1313
kind: ApiKey
14-
key: =Env.OPENAI_APIKEY
14+
key: =Env.OPENAI_API_KEY
1515
outputSchema:
1616
properties:
1717
language:

agent-samples/openai/OpenAIChat.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ model:
1111
topP: 0.95
1212
connection:
1313
kind: ApiKey
14-
key: =Env.OPENAI_APIKEY
14+
key: =Env.OPENAI_API_KEY
1515
outputSchema:
1616
properties:
1717
language:

agent-samples/openai/OpenAIResponses.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ model:
1111
topP: 0.95
1212
connection:
1313
kind: ApiKey
14-
key: =Env.OPENAI_APIKEY
14+
key: =Env.OPENAI_API_KEY
1515
outputSchema:
1616
properties:
1717
language:

dotnet/samples/GettingStarted/AgentProviders/Agent_With_AzureFoundryModel/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
using OpenAI.Chat;
1313

1414
var endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_OPENAI_ENDPOINT is not set.");
15-
var apiKey = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_APIKEY");
15+
var apiKey = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_OPENAI_API_KEY");
1616
var model = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_MODEL_DEPLOYMENT") ?? "Phi-4-mini-instruct";
1717

1818
// Since we are using the OpenAI Client SDK, we need to override the default endpoint to point to Azure Foundry.

dotnet/samples/GettingStarted/AgentProviders/Agent_With_AzureFoundryModel/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Set the following environment variables:
2727
$env:AZURE_FOUNDRY_OPENAI_ENDPOINT="https://ai-foundry-<myresourcename>.services.ai.azure.com/openai/v1/"
2828
2929
# Optional, defaults to using Azure CLI for authentication if not provided
30-
$env:AZURE_FOUNDRY_OPENAI_APIKEY="************"
30+
$env:AZURE_FOUNDRY_OPENAI_API_KEY="************"
3131
3232
# Optional, defaults to Phi-4-mini-instruct
3333
$env:AZURE_FOUNDRY_MODEL_DEPLOYMENT="Phi-4-mini-instruct"

dotnet/samples/GettingStarted/AgentProviders/Agent_With_OpenAIAssistants/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
using OpenAI;
1212
using OpenAI.Assistants;
1313

14-
var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
14+
var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
1515
var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";
1616

1717
const string JokerName = "Joker";

dotnet/samples/GettingStarted/AgentProviders/Agent_With_OpenAIAssistants/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ Before you begin, ensure you have the following prerequisites:
1111
Set the following environment variables:
1212

1313
```powershell
14-
$env:OPENAI_APIKEY="*****" # Replace with your OpenAI API key
14+
$env:OPENAI_API_KEY="*****" # Replace with your OpenAI API key
1515
$env:OPENAI_MODEL="gpt-4o-mini" # Optional, defaults to gpt-4o-mini
1616
```

dotnet/samples/GettingStarted/AgentProviders/Agent_With_OpenAIChatCompletion/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
using OpenAI;
88
using OpenAI.Chat;
99

10-
var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
10+
var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
1111
var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";
1212

1313
AIAgent agent = new OpenAIClient(

dotnet/samples/GettingStarted/AgentProviders/Agent_With_OpenAIChatCompletion/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ Before you begin, ensure you have the following prerequisites:
88
Set the following environment variables:
99

1010
```powershell
11-
$env:OPENAI_APIKEY="*****" # Replace with your OpenAI api key
11+
$env:OPENAI_API_KEY="*****" # Replace with your OpenAI api key
1212
$env:OPENAI_MODEL="gpt-4o-mini" # Optional, defaults to gpt-4o-mini
1313
```

dotnet/samples/GettingStarted/AgentProviders/Agent_With_OpenAIResponses/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using OpenAI;
77
using OpenAI.Responses;
88

9-
var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
9+
var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
1010
var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";
1111

1212
AIAgent agent = new OpenAIClient(

0 commit comments

Comments
 (0)