Skip to content

Update README hello world example #1075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ekzhu merged 2 commits into from
Oct 1, 2025
Merged

Update README hello world example #1075

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8f5beb
Update README hello world example
ekzhu Oct 1, 2025
0e97763
Merge branch 'main' into readme-helloworld
ekzhu Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ Welcome to Microsoft's comprehensive multi-language framework for building, orch
Python

```bash
# This will install all sub-packages, see `python/packages` for individual packages
pip install agent-framework
pip install agent-framework --prerelease=allow
# This will install all sub-packages, see `python/packages` for individual packages.
# It may take a minute on first install on Windows.
```

.NET
Expand Down Expand Up @@ -87,20 +88,27 @@ dotnet add package Microsoft.Agents.AI
Create a simple Azure Responses Agent that writes a haiku about the Microsoft Agent Framework

```python
# pip install agent-framework
# pip install agent-framework --prerelease=allow
# Use `az login` to authenticate with Azure CLI
import asyncio
from agent_framework.azure import AzureOpenAIResponsesClient
from azure.identity import AzureCliCredential


async def main():
# Initialize a chat agent with basic instructions
agent = AzureOpenAIResponsesClient(credential=AzureCliCredential()).create_agent(
name="HaikuBot",
instructions="You are an upbeat assistant that writes beautifully.",
)
# Initialize a chat agent with Azure OpenAI Responses
agent = AzureOpenAIResponsesClient(
endpoint="https://your-custom-endpoint.openai.azure.com/",

@moonbox3 moonbox3 Oct 1, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are automatically picked up from env vars or a .env file, which is why they aren’t explicitly included.

deployment_name="gpt-5",
api_version="2025-03-01-preview",
credential=AzureCliCredential(),
).create_agent(
name="HaikuBot",
instructions="You are an upbeat assistant that writes beautifully.",
)

print(await agent.run("Write a haiku about Microsoft Agent Framework."))

print(await agent.run("Write a haiku about Microsoft Agent Framework."))

asyncio.run(main())
```
Expand Down