Skip to content

Commit 6acab3d

Browse files
eavanvalkenburgCopilot
eavanvalkenburg
and
Copilot
authored
Python: [BREAKING] Standardize model selection on model (#4999)
* Refactor Anthropic model option and provider clients Rename the Anthropic client model option from model_id to model, add provider-specific Anthropic wrappers for Foundry, Bedrock, and Vertex, and expose them through the Anthropic, Foundry, Amazon, and Google namespaces. Update core option handling, docs, samples, and tests accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix Anthropic skills sample typing Cast the Anthropic beta client to Any in the skills sample so the pre-commit sample pyright check no longer fails on beta skills and files endpoints that are not exposed by the current SDK stubs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * undo sample mypy * Retry CI after transient external failures Retrigger PR validation after an unrelated Copilot review workflow SAML failure and a transient external tau2 git fetch failure in the Windows Python test setup. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address review feedback on model option merging Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address Anthropic compatibility review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * moved all to `model` * fixes for azure ai search * Python: standardize remaining sample env var names Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Python: fix foundry-local pyright compatibility Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * updated env vars in cicd --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 95550dd commit 6acab3d

184 files changed

Lines changed: 1749 additions & 1025 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/python-integration-tests.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,10 @@ jobs:
9595
environment: integration
9696
timeout-minutes: 60
9797
env:
98-
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
99-
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
100-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
101-
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }}
98+
AZURE_OPENAI_CHAT_MODEL: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
99+
AZURE_OPENAI_RESPONSES_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
100+
AZURE_OPENAI_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
101+
AZURE_OPENAI_EMBEDDING_MODEL: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }}
102102
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
103103
defaults:
104104
run:
@@ -139,7 +139,7 @@ jobs:
139139
timeout-minutes: 60
140140
env:
141141
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
142-
ANTHROPIC_CHAT_MODEL_ID: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
142+
ANTHROPIC_CHAT_MODEL: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
143143
LOCAL_MCP_URL: ${{ vars.LOCAL_MCP__URL }}
144144
defaults:
145145
run:
@@ -207,8 +207,8 @@ jobs:
207207
OPENAI_EMBEDDING_MODEL: ${{ vars.OPENAI_EMBEDDING_MODEL_ID }}
208208
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
209209
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
210-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
211-
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
210+
AZURE_OPENAI_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
211+
AZURE_OPENAI_CHAT_MODEL: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
212212
FOUNDRY_PROJECT_ENDPOINT: ${{ vars.FOUNDRY_PROJECT_ENDPOINT }}
213213
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL }}
214214
FUNCTIONS_WORKER_RUNTIME: "python"
@@ -256,7 +256,7 @@ jobs:
256256
timeout-minutes: 60
257257
env:
258258
AZURE_AI_PROJECT_ENDPOINT: ${{ secrets.AZUREAI__ENDPOINT }}
259-
AZURE_AI_MODEL_DEPLOYMENT_NAME: ${{ vars.AZUREAI__DEPLOYMENTNAME }}
259+
AZURE_AI_MODEL: ${{ vars.AZUREAI__DEPLOYMENTNAME }}
260260
FOUNDRY_PROJECT_ENDPOINT: ${{ vars.FOUNDRY_PROJECT_ENDPOINT }}
261261
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL }}
262262
FOUNDRY_AGENT_NAME: ${{ vars.FOUNDRY_AGENT_NAME }}

‎.github/workflows/python-merge-tests.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,10 @@ jobs:
192192
runs-on: ubuntu-latest
193193
environment: integration
194194
env:
195-
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
196-
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
197-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
198-
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }}
195+
AZURE_OPENAI_CHAT_MODEL: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
196+
AZURE_OPENAI_RESPONSES_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
197+
AZURE_OPENAI_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
198+
AZURE_OPENAI_EMBEDDING_MODEL: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME }}
199199
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
200200
defaults:
201201
run:
@@ -255,7 +255,7 @@ jobs:
255255
environment: integration
256256
env:
257257
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
258-
ANTHROPIC_CHAT_MODEL_ID: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
258+
ANTHROPIC_CHAT_MODEL: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
259259
LOCAL_MCP_URL: ${{ vars.LOCAL_MCP__URL }}
260260
defaults:
261261
run:
@@ -336,8 +336,8 @@ jobs:
336336
OPENAI_EMBEDDING_MODEL: ${{ vars.OPENAI_EMBEDDING_MODEL_ID }}
337337
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
338338
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
339-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
340-
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
339+
AZURE_OPENAI_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
340+
AZURE_OPENAI_CHAT_MODEL: ${{ vars.AZUREOPENAI__CHATDEPLOYMENTNAME }}
341341
FOUNDRY_PROJECT_ENDPOINT: ${{ vars.FOUNDRY_PROJECT_ENDPOINT }}
342342
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL }}
343343
FUNCTIONS_WORKER_RUNTIME: "python"
@@ -398,7 +398,7 @@ jobs:
398398
environment: integration
399399
env:
400400
AZURE_AI_PROJECT_ENDPOINT: ${{ secrets.AZUREAI__ENDPOINT }}
401-
AZURE_AI_MODEL_DEPLOYMENT_NAME: ${{ vars.AZUREAI__DEPLOYMENTNAME }}
401+
AZURE_AI_MODEL: ${{ vars.AZUREAI__DEPLOYMENTNAME }}
402402
FOUNDRY_PROJECT_ENDPOINT: ${{ vars.FOUNDRY_PROJECT_ENDPOINT }}
403403
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL }}
404404
FOUNDRY_AGENT_NAME: ${{ vars.FOUNDRY_AGENT_NAME }}

‎.github/workflows/python-sample-validation.yml‎

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,13 @@ jobs:
6565
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
6666
# Azure OpenAI configuration
6767
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
68-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
69-
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME || vars.AZUREOPENAI__EMBEDDINGDEPLOYMENTNAME }}
68+
AZURE_OPENAI_MODEL: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
69+
AZURE_OPENAI_RESPONSES_MODEL: ${{ vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
70+
AZURE_OPENAI_EMBEDDING_MODEL: ${{ vars.AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME || vars.AZUREOPENAI__EMBEDDINGDEPLOYMENTNAME }}
7071
# OpenAI configuration
7172
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
72-
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
73-
OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
73+
OPENAI_CHAT_MODEL: ${{ vars.OPENAI__CHATMODELID }}
74+
OPENAI_RESPONSES_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
7475
# GitHub MCP
7576
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
7677
OPENAI_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
@@ -95,11 +96,12 @@ jobs:
9596
echo "FOUNDRY_PROJECT_ENDPOINT=$FOUNDRY_PROJECT_ENDPOINT" >> .env
9697
echo "FOUNDRY_MODEL=$FOUNDRY_MODEL" >> .env
9798
echo "AZURE_OPENAI_ENDPOINT=$AZURE_OPENAI_ENDPOINT" >> .env
98-
echo "AZURE_OPENAI_DEPLOYMENT_NAME=$AZURE_OPENAI_DEPLOYMENT_NAME" >> .env
99-
echo "AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME=$AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME" >> .env
99+
echo "AZURE_OPENAI_MODEL=$AZURE_OPENAI_MODEL" >> .env
100+
echo "AZURE_OPENAI_RESPONSES_MODEL=$AZURE_OPENAI_RESPONSES_MODEL" >> .env
101+
echo "AZURE_OPENAI_EMBEDDING_MODEL=$AZURE_OPENAI_EMBEDDING_MODEL" >> .env
100102
echo "OPENAI_API_KEY=$OPENAI_API_KEY" >> .env
101-
echo "OPENAI_CHAT_MODEL_ID=$OPENAI_CHAT_MODEL_ID" >> .env
102-
echo "OPENAI_RESPONSES_MODEL_ID=$OPENAI_RESPONSES_MODEL_ID" >> .env
103+
echo "OPENAI_CHAT_MODEL=$OPENAI_CHAT_MODEL" >> .env
104+
echo "OPENAI_RESPONSES_MODEL=$OPENAI_RESPONSES_MODEL" >> .env
103105
echo "GITHUB_PAT=$GITHUB_PAT" >> .env
104106
105107
- name: Run sample validation
@@ -120,8 +122,8 @@ jobs:
120122
env:
121123
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
122124
OPENAI_MODEL: ${{ vars.OPENAI__CHATMODELID }}
123-
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
124-
OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
125+
OPENAI_CHAT_MODEL: ${{ vars.OPENAI__CHATMODELID }}
126+
OPENAI_RESPONSES_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
125127
defaults:
126128
run:
127129
working-directory: python
@@ -140,8 +142,8 @@ jobs:
140142
run: |
141143
echo "OPENAI_API_KEY=$OPENAI_API_KEY" >> .env
142144
echo "OPENAI_MODEL=$OPENAI_MODEL" >> .env
143-
echo "OPENAI_CHAT_MODEL_ID=$OPENAI_CHAT_MODEL_ID" >> .env
144-
echo "OPENAI_RESPONSES_MODEL_ID=$OPENAI_RESPONSES_MODEL_ID" >> .env
145+
echo "OPENAI_CHAT_MODEL=$OPENAI_CHAT_MODEL" >> .env
146+
echo "OPENAI_RESPONSES_MODEL=$OPENAI_RESPONSES_MODEL" >> .env
145147
146148
- name: Run sample validation
147149
run: |
@@ -160,7 +162,7 @@ jobs:
160162
environment: integration
161163
env:
162164
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
163-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
165+
AZURE_OPENAI_MODEL: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
164166
AZURE_OPENAI_API_VERSION: ${{ vars.AZURE_OPENAI_API_VERSION || '' }}
165167
defaults:
166168
run:
@@ -179,7 +181,7 @@ jobs:
179181
- name: Create .env for samples
180182
run: |
181183
echo "AZURE_OPENAI_ENDPOINT=$AZURE_OPENAI_ENDPOINT" >> .env
182-
echo "AZURE_OPENAI_DEPLOYMENT_NAME=$AZURE_OPENAI_DEPLOYMENT_NAME" >> .env
184+
echo "AZURE_OPENAI_MODEL=$AZURE_OPENAI_MODEL" >> .env
183185
echo "AZURE_OPENAI_API_VERSION=$AZURE_OPENAI_API_VERSION" >> .env
184186
185187
- name: Run sample validation
@@ -199,7 +201,7 @@ jobs:
199201
environment: integration
200202
env:
201203
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
202-
ANTHROPIC_CHAT_MODEL_ID: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
204+
ANTHROPIC_CHAT_MODEL: ${{ vars.ANTHROPIC_CHAT_MODEL_ID }}
203205
defaults:
204206
run:
205207
working-directory: python
@@ -217,7 +219,7 @@ jobs:
217219
- name: Create .env for samples
218220
run: |
219221
echo "ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY" >> .env
220-
echo "ANTHROPIC_CHAT_MODEL_ID=$ANTHROPIC_CHAT_MODEL_ID" >> .env
222+
echo "ANTHROPIC_CHAT_MODEL=$ANTHROPIC_CHAT_MODEL" >> .env
221223
222224
- name: Run sample validation
223225
run: |
@@ -265,7 +267,7 @@ jobs:
265267
runs-on: ubuntu-latest
266268
environment: integration
267269
env:
268-
BEDROCK_CHAT_MODEL_ID: ${{ vars.BEDROCK__CHATMODELID }}
270+
BEDROCK_CHAT_MODEL: ${{ vars.BEDROCK__CHATMODELID }}
269271
defaults:
270272
run:
271273
working-directory: python
@@ -518,7 +520,7 @@ jobs:
518520
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
519521
# Azure OpenAI configuration
520522
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
521-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
523+
AZURE_OPENAI_MODEL: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
522524
# Azure AI Search (for evaluation samples)
523525
AZURE_SEARCH_ENDPOINT: ${{ secrets.AZURE_SEARCH_ENDPOINT }}
524526
AZURE_SEARCH_API_KEY: ${{ secrets.AZURE_SEARCH_API_KEY }}
@@ -560,11 +562,11 @@ jobs:
560562
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
561563
# Azure OpenAI configuration
562564
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
563-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
565+
AZURE_OPENAI_MODEL: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
564566
# OpenAI configuration
565567
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
566-
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
567-
OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
568+
OPENAI_CHAT_MODEL: ${{ vars.OPENAI__CHATMODELID }}
569+
OPENAI_RESPONSES_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
568570
OPENAI_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
569571
defaults:
570572
run:
@@ -585,10 +587,10 @@ jobs:
585587
echo "FOUNDRY_PROJECT_ENDPOINT=$FOUNDRY_PROJECT_ENDPOINT" >> .env
586588
echo "FOUNDRY_MODEL=$FOUNDRY_MODEL" >> .env
587589
echo "AZURE_OPENAI_ENDPOINT=$AZURE_OPENAI_ENDPOINT" >> .env
588-
echo "AZURE_OPENAI_DEPLOYMENT_NAME=$AZURE_OPENAI_DEPLOYMENT_NAME" >> .env
590+
echo "AZURE_OPENAI_MODEL=$AZURE_OPENAI_MODEL" >> .env
589591
echo "OPENAI_API_KEY=$OPENAI_API_KEY" >> .env
590-
echo "OPENAI_CHAT_MODEL_ID=$OPENAI_CHAT_MODEL_ID" >> .env
591-
echo "OPENAI_RESPONSES_MODEL_ID=$OPENAI_RESPONSES_MODEL_ID" >> .env
592+
echo "OPENAI_CHAT_MODEL=$OPENAI_CHAT_MODEL" >> .env
593+
echo "OPENAI_RESPONSES_MODEL=$OPENAI_RESPONSES_MODEL" >> .env
592594
593595
- name: Run sample validation
594596
run: |
@@ -610,11 +612,11 @@ jobs:
610612
FOUNDRY_MODEL: ${{ vars.FOUNDRY_MODEL || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
611613
# Azure OpenAI configuration
612614
AZURE_OPENAI_ENDPOINT: ${{ vars.AZUREOPENAI__ENDPOINT }}
613-
AZURE_OPENAI_DEPLOYMENT_NAME: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
615+
AZURE_OPENAI_MODEL: ${{ vars.AZURE_OPENAI_DEPLOYMENT_NAME || vars.AZUREOPENAI__RESPONSESDEPLOYMENTNAME }}
614616
# OpenAI configuration
615617
OPENAI_API_KEY: ${{ secrets.OPENAI__APIKEY }}
616-
OPENAI_CHAT_MODEL_ID: ${{ vars.OPENAI__CHATMODELID }}
617-
OPENAI_RESPONSES_MODEL_ID: ${{ vars.OPENAI__RESPONSESMODELID }}
618+
OPENAI_CHAT_MODEL: ${{ vars.OPENAI__CHATMODELID }}
619+
OPENAI_RESPONSES_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
618620
OPENAI_MODEL: ${{ vars.OPENAI__RESPONSESMODELID }}
619621
# Copilot Studio
620622
COPILOTSTUDIOAGENT__ENVIRONMENTID: ${{ secrets.COPILOTSTUDIOAGENT__ENVIRONMENTID }}
@@ -640,10 +642,10 @@ jobs:
640642
echo "FOUNDRY_PROJECT_ENDPOINT=$FOUNDRY_PROJECT_ENDPOINT" >> .env
641643
echo "FOUNDRY_MODEL=$FOUNDRY_MODEL" >> .env
642644
echo "AZURE_OPENAI_ENDPOINT=$AZURE_OPENAI_ENDPOINT" >> .env
643-
echo "AZURE_OPENAI_DEPLOYMENT_NAME=$AZURE_OPENAI_DEPLOYMENT_NAME" >> .env
645+
echo "AZURE_OPENAI_MODEL=$AZURE_OPENAI_MODEL" >> .env
644646
echo "OPENAI_API_KEY=$OPENAI_API_KEY" >> .env
645-
echo "OPENAI_CHAT_MODEL_ID=$OPENAI_CHAT_MODEL_ID" >> .env
646-
echo "OPENAI_RESPONSES_MODEL_ID=$OPENAI_RESPONSES_MODEL_ID" >> .env
647+
echo "OPENAI_CHAT_MODEL=$OPENAI_CHAT_MODEL" >> .env
648+
echo "OPENAI_RESPONSES_MODEL=$OPENAI_RESPONSES_MODEL" >> .env
647649
echo "COPILOTSTUDIOAGENT__ENVIRONMENTID=$COPILOTSTUDIOAGENT__ENVIRONMENTID" >> .env
648650
echo "COPILOTSTUDIOAGENT__SCHEMANAME=$COPILOTSTUDIOAGENT__SCHEMANAME" >> .env
649651
echo "COPILOTSTUDIOAGENT__TENANTID=$COPILOTSTUDIOAGENT__TENANTID" >> .env

‎python/.env.example‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ OPENAI_CHAT_MODEL=""
1717
OPENAI_RESPONSES_MODEL=""
1818
# Azure OpenAI
1919
AZURE_OPENAI_ENDPOINT=""
20-
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME=""
21-
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME=""
20+
AZURE_OPENAI_CHAT_MODEL=""
21+
AZURE_OPENAI_RESPONSES_MODEL=""
2222
# Mem0
2323
MEM0_API_KEY=""
2424
# Copilot Studio

‎python/CODING_STANDARD.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ A more complete example with keyword arguments and code samples:
480480

481481
```python
482482
def create_client(
483-
model_id: str | None = None,
483+
model: str | None = None,
484484
*,
485485
timeout: float | None = None,
486486
env_file_path: str | None = None,
@@ -489,7 +489,7 @@ def create_client(
489489
"""Create a new client with the specified configuration.
490490
491491
Args:
492-
model_id: The model ID to use. If not provided,
492+
model: The model ID to use. If not provided,
493493
it will be loaded from settings.
494494
495495
Keyword Args:
@@ -501,14 +501,14 @@ def create_client(
501501
A configured client instance.
502502
503503
Raises:
504-
ValueError: If the model_id is invalid.
504+
ValueError: If the model is invalid.
505505
506506
Examples:
507507
508508
.. code-block:: python
509509
510510
# Create a client with default settings:
511-
client = create_client(model_id="gpt-4o")
511+
client = create_client(model="gpt-4o")
512512
513513
# Or load from environment:
514514
client = create_client(env_file_path=".env")

‎python/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ OPENAI_MODEL=...
5151
...
5252
AZURE_OPENAI_API_KEY=...
5353
AZURE_OPENAI_ENDPOINT=...
54-
AZURE_OPENAI_DEPLOYMENT_NAME=...
54+
AZURE_OPENAI_MODEL=...
5555
...
5656
FOUNDRY_PROJECT_ENDPOINT=...
5757
FOUNDRY_MODEL=...

‎python/packages/ag-ui/agent_framework_ag_ui/_types.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class AGUIChatOptions(ChatOptions[ResponseModelT], Generic[ResponseModelT], tota
108108
109109
Keys:
110110
# Inherited from ChatOptions (forwarded to remote server):
111-
model_id: The model identifier (forwarded as-is to server).
111+
model: The model identifier (forwarded as-is to server).
112112
temperature: Sampling temperature.
113113
top_p: Nucleus sampling parameter.
114114
max_tokens: Maximum tokens to generate.

‎python/packages/ag-ui/getting_started/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,13 +191,13 @@ from fastapi import FastAPI
191191

192192
# Read required configuration
193193
endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
194-
deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
194+
model = os.environ.get("AZURE_OPENAI_MODEL")
195195
api_key = os.environ.get("AZURE_OPENAI_API_KEY")
196196

197197
if not endpoint:
198198
raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
199-
if not deployment_name:
200-
raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")
199+
if not model:
200+
raise ValueError("AZURE_OPENAI_MODEL environment variable is required")
201201
if not api_key:
202202
raise ValueError("AZURE_OPENAI_API_KEY environment variable is required")
203203

@@ -207,7 +207,7 @@ agent = Agent(
207207
instructions="You are a helpful assistant.",
208208
client=OpenAIChatCompletionClient(
209209
azure_endpoint=endpoint,
210-
model=deployment_name,
210+
model=model,
211211
api_key=api_key,
212212
),
213213
)
@@ -230,7 +230,7 @@ if __name__ == "__main__":
230230
- **`Agent`**: The agent that will handle incoming requests
231231
- **FastAPI Integration**: Uses FastAPI's native async support for streaming responses
232232
- **Instructions**: The agent is created with default instructions, which can be overridden by client messages
233-
- **Configuration**: `OpenAIChatCompletionClient` can read from environment variables (`AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_DEPLOYMENT_NAME`, `AZURE_OPENAI_API_KEY`) or accept parameters directly
233+
- **Configuration**: `OpenAIChatCompletionClient` can read from environment variables (`AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_MODEL`, `AZURE_OPENAI_API_KEY`) or accept parameters directly
234234

235235
**Alternative (simpler)**: Use environment variables only:
236236

@@ -249,7 +249,7 @@ Set the required environment variables:
249249

250250
```bash
251251
export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
252-
export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-4o-mini"
252+
export AZURE_OPENAI_MODEL="gpt-4o-mini"
253253
# Optional: Set API key if not using DefaultAzureCredential
254254
# export AZURE_OPENAI_API_KEY="your-api-key"
255255
```

‎python/packages/ag-ui/getting_started/server.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@
2626

2727
# Read required configuration
2828
endpoint = os.environ.get("AZURE_OPENAI_ENDPOINT")
29-
deployment_name = os.environ.get("AZURE_OPENAI_DEPLOYMENT_NAME")
29+
model = os.environ.get("AZURE_OPENAI_MODEL")
3030

3131
if not endpoint:
3232
raise ValueError("AZURE_OPENAI_ENDPOINT environment variable is required")
33-
if not deployment_name:
34-
raise ValueError("AZURE_OPENAI_DEPLOYMENT_NAME environment variable is required")
33+
if not model:
34+
raise ValueError("AZURE_OPENAI_MODEL environment variable is required")
3535

3636

3737
# ============================================================================
@@ -121,7 +121,7 @@ def get_time_zone(location: str) -> str:
121121
instructions="You are a helpful assistant. Use get_weather for weather and get_time_zone for time zones.",
122122
client=OpenAIChatCompletionClient(
123123
azure_endpoint=endpoint,
124-
model=deployment_name,
124+
model=model,
125125
),
126126
tools=[get_time_zone], # ONLY server-side tools
127127
)

0 commit comments

Comments
 (0)