Repository navigation
Python: list FOUNDRY_* settings in the multimodal input sample README - #9757
NingLin Liu (ninglinLiu) wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes match the samples’ configuration and authentication requirements, with no unresolved findings.
No open issues 🎉
What changed in this PR
This PR corrects configuration guidance for the Python multimodal input samples to match their use of FoundryChatClient. Changes are limited to documentation and comments; runtime behavior is unchanged.
Changes:
- Replace obsolete Azure OpenAI settings with
FOUNDRY_PROJECT_ENDPOINTandFOUNDRY_MODEL. - Document the
az loginprerequisite forAzureCliCredential. - Correct environment-variable names in both Azure sample comments.
| File | Description |
|---|---|
python/samples/02-agents/multimodal_input/README.md |
Correct required settings and authentication guidance. |
python/samples/02-agents/multimodal_input/azure_responses_multimodal.py |
Correct the endpoint variable in a configuration comment. |
python/samples/02-agents/multimodal_input/azure_chat_multimodal.py |
Correct the endpoint variable in a configuration comment. |
Review effort: Balanced
|
Thanks for correcting the sample setup, NingLin Liu (@ninglinLiu). Earlier open #9735 already makes the same Foundry environment-variable correction for these multimodal samples. The authentication note and adjacent comment updates here are part of that same setup fix, so I'm closing this newer PR as a duplicate to keep the fix and review in one place. |
Motivation & Context
The multimodal input README tells users to set
AZURE_OPENAI_ENDPOINTandAZURE_OPENAI_MODEL(listed twice) for the Azure samples, plus optionalAZURE_OPENAI_API_VERSION/AZURE_OPENAI_API_KEY. Butazure_chat_multimodal.pyandazure_responses_multimodal.pyboth buildFoundryChatClient(credential=AzureCliCredential()), which reads its settings withenv_prefix="FOUNDRY_"(FOUNDRY_PROJECT_ENDPOINT,FOUNDRY_MODEL) and takes no API key or API version. Following the README leaves the sample failing withModel is required. Set via 'model' parameter or 'FOUNDRY_MODEL' environment variable.The in-code comments in both samples also sayRequires AZURE_OPENAI_ENDPOINT and FOUNDRY_MODEL.Description & Review Guide
python/samples/02-agents/multimodal_input/README.md: the Azure section now listsFOUNDRY_PROJECT_ENDPOINTandFOUNDRY_MODEL(the settingsFoundryChatClientreads) and notes theaz loginrequirement, replacing the duplicatedAZURE_OPENAI_MODELlines and the API version/key options the client does not use.azure_chat_multimodal.py,azure_responses_multimodal.py: the comment now saysRequires FOUNDRY_PROJECT_ENDPOINT and FOUNDRY_MODEL.RawFoundryChatClient.__init__inpackages/foundry/agent_framework_foundry/_chat_client.py(env_prefix="FOUNDRY_", theFOUNDRY_MODELerror). The OpenAI section of the README is unchanged and still correct (openai_chat_multimodal.pypasses the model explicitly).Related Issue
N/A - trivial change. Stale environment-variable names in one sample README and two comments; the correction follows what the samples already read, with no behavior change.
AI Assistance
AI assistance details: finding the mismatch (README variables vs. the client settings the samples use), 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.