Skip to content

Commit 1a2b4fb

Browse files
authored
docs: correct three README errors found by following them (microsoft#8822)
The root quickstart reads FOUNDRY_MODEL_DEPLOYMENT_NAME, which is a variable in our dotnet integration workflow but not one FoundryChatClient reads -- it uses FOUNDRY_MODEL, as python/README.md already says. Uncommenting the line as written raises "Model is required". 01-get-started marks FOUNDRY_MODEL "optional, defaults to gpt-4o". It has no default; the constructor raises when it is unset, which test_foundry_chat_client.py pins. Only the comment is wrong. 01-get-started also refers to a Sample 08 that does not exist here. The hosting samples moved to the durable-extension repo, which the same file already links.
1 parent 987b345 commit 1a2b4fb

2 files changed

Lines changed: 2 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ async def main():
128128
client=FoundryChatClient(
129129
credential=AzureCliCredential(),
130130
# project_endpoint=os.environ["FOUNDRY_PROJECT_ENDPOINT"],
131-
# model=os.environ["FOUNDRY_MODEL_DEPLOYMENT_NAME"],
131+
# model=os.environ["FOUNDRY_MODEL"],
132132
),
133133
name="HaikuAgent",
134134
instructions="You are an upbeat assistant that writes beautifully.",

‎python/samples/01-get-started/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,11 @@ concepts of **Agent Framework** one step at a time.
99
pip install agent-framework-foundry
1010
```
1111

12-
Sample 08 additionally requires `agent-framework-azurefunctions --pre`.
13-
1412
Set the required environment variables:
1513

1614
```bash
1715
export FOUNDRY_PROJECT_ENDPOINT="https://your-project-endpoint"
18-
export FOUNDRY_MODEL="gpt-4o" # optional, defaults to gpt-4o
16+
export FOUNDRY_MODEL="gpt-4o"
1917
```
2018

2119
## Samples

0 commit comments

Comments
 (0)