Repository navigation
Python: clarify getting-started environment setup - #9668
Open
LI (ktz03) wants to merge 1 commit into
Open
LI (ktz03) wants to merge 1 commit into
LI (ktz03) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The focused documentation changes match the existing sample configuration behavior, with no unresolved issues.
No open issues 🎉
What changed in this PR
Clarifies environment setup in the Python sample overview to match the getting-started samples’ existing configuration behavior. This is documentation-only, with no runtime or API changes.
Changes:
- Explains that explicit
FoundryChatClientexample values must be replaced and override environment variables. - Documents removing those arguments for environment-based configuration and calling
load_dotenv()when using.env. - Links to the getting-started prerequisites.
| File | Description |
|---|---|
python/samples/README.md |
Clarifies constructor overrides and environment-based setup for getting-started samples. |
Review effort: Balanced
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 Python sample overview tells readers to configure a
.envfile orFOUNDRY_*environment variables for the getting-started samples. Those samples pass exampleproject_endpointandmodelarguments directly toFoundryChatClient, so setting environment variables alone leaves the placeholders in use.Description & Review Guide
load_dotenv()for the Option 1.envsetup. Link the existing getting-started prerequisites.01-get-started/README.mdand the explicit arguments in01_hello_agent.py. Source and documentation checks were performed; no model calls, SDK build, or product test suite was run.Related Issue
N/A - trivial change. This corrects setup instructions to match the existing sample and its already-documented configuration procedure; no behavior or design change is proposed.
AI Assistance
AI assistance details: Codex: documentation 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.