Repository navigation
Python: use FOUNDRY_MODEL in the Content Understanding DevUI sample READMEs - #9740
NingLin Liu (ninglinLiu) wants to merge 1 commit into
Conversation
|
NingLin Liu (@ninglinLiu) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
1 similar comment
|
NingLin Liu (@ninglinLiu) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
🟢 Approval recommended
Both documentation corrections match the agents’ existing FOUNDRY_MODEL reads, with no unresolved issues.
No open issues 🎉
What changed in this PR
Corrects the setup instructions for two Content Understanding DevUI samples to match the environment variable their agents already read.
Changes:
- Replaces
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAMEwithFOUNDRY_MODELin both README environment blocks. - Leaves sample code, model values, and other environment variables unchanged.
| File | Description |
|---|---|
python/samples/02-agents/devui/agent_content_understanding/README.md |
Corrects the model environment variable in setup instructions. |
python/samples/02-agents/devui/agent_content_understanding_file_search_azure_openai/README.md |
Applies the same correction to the file-search sample. |
Review effort: Balanced
Motivation & Context
The setup steps in the two Content Understanding DevUI sample READMEs tell users to set
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME=gpt-4.1, but neither sample reads that variable. Bothagent.pyfiles build the client withmodel=os.environ["FOUNDRY_MODEL"](and listFOUNDRY_MODELin their docstrings), so a.envwritten from the README fails withKeyError: 'FOUNDRY_MODEL'when DevUI loads the agent.Description & Review Guide
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAMEwithFOUNDRY_MODELin the environment-variable block of:python/samples/02-agents/devui/agent_content_understanding/README.mdpython/samples/02-agents/devui/agent_content_understanding_file_search_azure_openai/README.mdFOUNDRY_MODELis the variable the samples read:agent_content_understanding/agent.pyline 49 andagent_content_understanding_file_search_azure_openai/agent.pyline 62. No other variable in either block is affected (FOUNDRY_PROJECT_ENDPOINTandAZURE_CONTENTUNDERSTANDING_ENDPOINTmatch the code).Related Issue
N/A - trivial change. A stale environment-variable name in two README setup blocks; the correction follows the variable the existing sample code already reads, with no behavior change.
AI Assistance
AI assistance details: finding the mismatch (README variables vs.
os.environreads in the samples), the documentation edit, and this PR description.Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.