Skip to content

Update README hello world example#1075

Merged
ekzhu merged 2 commits into
microsoft:mainfrom
ekzhu:readme-helloworld
Oct 1, 2025
Merged

Update README hello world example#1075
ekzhu merged 2 commits into
microsoft:mainfrom
ekzhu:readme-helloworld

Conversation

@ekzhu

@ekzhu ekzhu commented Oct 1, 2025

Copy link
Copy Markdown
Contributor

Resolves #1073

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

Copilot AI review requested due to automatic review settings October 1, 2025 19:08

Copilot AI left a comment

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.

Pull Request Overview

This PR updates the README.md file to improve the hello world example for the Python installation and usage instructions. The changes address installation command updates and provide more comprehensive configuration examples.

  • Updates pip install command to include prerelease flag
  • Enhances the Azure OpenAI example with explicit configuration parameters
  • Adds helpful installation notes for Windows users

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@markwallace-microsoft markwallace-microsoft added the documentation Improvements or additions to documentation label Oct 1, 2025
@ekzhu ekzhu enabled auto-merge October 1, 2025 19:28
@ekzhu ekzhu added this pull request to the merge queue Oct 1, 2025
Comment thread README.md
)
# Initialize a chat agent with Azure OpenAI Responses
agent = AzureOpenAIResponsesClient(
endpoint="https://your-custom-endpoint.openai.azure.com/",

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.

Merged via the queue into microsoft:main with commit 9a59b86 Oct 1, 2025
8 checks passed
ReubenBond pushed a commit to ReubenBond/agent-framework that referenced this pull request Oct 28, 2025
Arturo-Quiroga-MSFT pushed a commit to Arturo-Quiroga-MSFT/agent-framework-public that referenced this pull request Nov 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: README: Python Quickstart should be clear enough users can run without error

6 participants