Repository navigation
Python: use FOUNDRY_* settings in the ChatKit integration sample README - #9758
Open
NingLin Liu (ninglinLiu) wants to merge 13 commits into
Open
NingLin Liu (ninglinLiu) wants to merge 13 commits into
NingLin Liu (ninglinLiu) wants to merge 13 commits into
Conversation
NingLin Liu (ninglinLiu)
requested review from
SergeyMenshykh,
Tao Chen (TaoChenOSU),
Eduard van Valkenburg (eavanvalkenburg),
Giles Odigwe (giles17),
Jose Alvarez (jpalvarezl),
Evan Mattson (moonbox3),
Roger Barreto (rogerbarreto),
sophia-ramsey and
westey (westey-m)
as code owners
October 27, 2026 12:49
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 27, 2026 12:49 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 27, 2026 12:50 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
force-pushed
the
docs/chatkit-foundry-env
branch
from
October 27, 2026 12:50
0afe57f to
72cff89
Compare
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 27, 2026 12:50 — with
GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation corrections match the existing integration, with only a minor installation-command convention issue remaining.
1 open issue
What changed in this PR
This documentation-only change aligns the ChatKit sample’s backend setup with its existing FoundryChatClient integration.
Changes:
- Replace Azure OpenAI settings with
FOUNDRY_PROJECT_ENDPOINTandFOUNDRY_MODEL. - Add
agent-framework-foundryto the installation command. - Update the prerequisite to a Microsoft Foundry project with a deployed model.
| File | Description |
|---|---|
python/samples/05-end-to-end/chatkit-integration/README.md |
Align prerequisites, dependencies, and environment settings with the Foundry backend. |
Review effort: Balanced
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 27, 2026 13:01 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
requested a review
from Darren Cohen (dargilco)
as a code owner
October 30, 2026 08:41
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 08:41 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 08:48 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 09:12 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 11:35 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 12:08 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 14:06 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 16:05 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 17:20 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 17:22 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
temporarily deployed
to
github-app-auth
October 30, 2026 17:40 — with
GitHub Actions
Inactive
NingLin Liu (ninglinLiu)
deployed
to
github-app-auth
October 30, 2026 19:33 — with
GitHub Actions
Active
This branch was successfully 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
The ChatKit integration README's backend setup asks for
AZURE_OPENAI_ENDPOINT,AZURE_OPENAI_API_VERSIONandAZURE_OPENAI_MODEL, butapp.pycreates its agent withFoundryChatClient(credential=AzureCliCredential())(imported fromagent_framework.foundry). That client readsFOUNDRY_PROJECT_ENDPOINTandFOUNDRY_MODEL(env_prefix="FOUNDRY_") and ignores theAZURE_OPENAI_*variables, so following the README fails at startup withModel is required. Set via 'model' parameter or 'FOUNDRY_MODEL' environment variable.The install line also omitsagent-framework-foundry, which providesagent_framework.foundry.FoundryChatClient(agent-framework-chatkitonly depends onagent-framework-core), so the import fails first.Description & Review Guide
python/samples/05-end-to-end/chatkit-integration/README.md:FOUNDRY_PROJECT_ENDPOINTandFOUNDRY_MODELinstead of theAZURE_OPENAI_*variables;pip installline addsagent-framework-foundry;app.pyline 34 (from agent_framework.foundry import FoundryChatClient) and line 225 (FoundryChatClient(credential=AzureCliCredential())), andRawFoundryChatClient.__init__inpackages/foundry/agent_framework_foundry/_chat_client.py.Related Issue
N/A - trivial change. Stale setup instructions in one sample README; the correction follows what the existing sample already uses, with no behavior change.
AI Assistance
AI assistance details: finding the mismatch (README setup vs. the client and import the sample uses), 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.