Repository navigation
Python: Point Foundry-migrated sample READMEs at the settings the code reads - #9759
Draft
Naveen Chatlapalli (1aifanatic) wants to merge 1 commit into
Conversation
…e reads These samples read FOUNDRY_PROJECT_ENDPOINT / FOUNDRY_MODEL (and AZURE_OPENAI_EMBEDDING_MODEL for Foundry memory), but their READMEs still ask for AZURE_OPENAI_* names from before the Foundry migration, so a reader following the README hits a KeyError. Also show the Foundry project endpoint format where a README showed an Azure ML or Azure OpenAI host. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Naveen Chatlapalli (1aifanatic)
temporarily deployed
to
github-app-auth
October 27, 2026 12:51 — with
GitHub Actions
Inactive
Naveen Chatlapalli (1aifanatic)
temporarily deployed
to
github-app-auth
October 27, 2026 12:52 — with
GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The narrow documentation corrections match the sample configuration contracts, with no unresolved issues identified.
No open issues 🎉
What changed in this PR
Updates six Python sample READMEs to document the settings their existing Foundry-based implementations read. These are documentation-only corrections; runtime behavior is unchanged.
Changes:
- Replace outdated model and embedding environment variable names.
- Correct two Foundry project endpoint examples.
- Align ChatKit prerequisites and component descriptions with
FoundryChatClient.
| File | Description |
|---|---|
python/samples/05-end-to-end/chatkit-integration/README.md |
Documents Foundry configuration, prerequisites, and client usage. |
python/samples/02-agents/skills/mixed_skills/README.md |
Corrects the project endpoint and model variable. |
python/samples/02-agents/skills/file_based_skill/README.md |
Uses FOUNDRY_MODEL for model configuration. |
python/samples/02-agents/devui/agent_content_understanding/README.md |
Corrects the project endpoint and model variable. |
python/samples/02-agents/devui/agent_content_understanding_file_search_azure_openai/README.md |
Uses FOUNDRY_MODEL for model configuration. |
python/samples/02-agents/context_providers/README.md |
Corrects the embedding model variable. |
Review effort: Balanced
6 of 7 tasks
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation & Context
These Python samples moved to
FoundryChatClientin the Foundry migration (#6557), but their READMEs still tell readers to setAZURE_OPENAI_*names that the code never reads. This is the Python counterpart of #9600 for .NET.02-agents/devui/agent_content_understandingAZURE_OPENAI_RESPONSES_DEPLOYMENT_NAMEFOUNDRY_MODELKeyError: 'FOUNDRY_MODEL'at import02-agents/devui/agent_content_understanding_file_search_azure_openaiFOUNDRY_MODEL02-agents/context_providers(azure_ai_foundry_memory.py)AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAMEAZURE_OPENAI_EMBEDDING_MODELKeyError02-agents/skills/file_based_skill,mixed_skillsAZURE_OPENAI_MODELFOUNDRY_MODEL, defaultgpt-4o-mini05-end-to-end/chatkit-integrationAZURE_OPENAI_ENDPOINT/_API_VERSION/_MODELFoundryChatClient(FOUNDRY_PROJECT_ENDPOINT,FOUNDRY_MODEL)ValueError: Model is required. Set via 'model' parameter or 'FOUNDRY_MODEL' environment variable.Two READMEs also show a
FOUNDRY_PROJECT_ENDPOINTthat is not a Foundry project endpoint:https://your-project.api.azureml.msandhttps://your-project.openai.azure.com/.Description & Review Guide
https://<account>.services.ai.azure.com/api/projects/<project>endpoint format that the sibling READMEs use.FoundryChatClient.I found these by comparing the environment variables each sample README names with the names its Python files and
.envtemplates reference. The rows above with errors were reproduced by setting only the README's variables. The other matches from that comparison are variables the OpenAI/Azure clients read implicitly, such asAZURE_OPENAI_API_KEYin the chat-client README, so they are correct and unchanged.Related Issue
N/A - trivial change: the READMEs are corrected to the variable names the samples already read.
AI Assistance
AI assistance details: Claude Code helped compare README variables with what each sample reads, reproduce the failures, make the edits, and draft this 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.🤖 Generated with Claude Code