Repository navigation
docs: Add clarifying documentation for FoundryAgent vs FoundryChatClient - #5161
Saurabh Shandilya (beyondszine) wants to merge 9 commits into
Conversation
Add documentation explaining when to use FoundryAgent (connecting to existing Foundry agents) vs FoundryChatClient (direct model access). This addresses the confusion raised in issue microsoft#5160.
Use get_response() instead of complete() which is the correct method name from the base client class.
|
@microsoft-github-policy-service agree company="microsoft" |
There was a problem hiding this comment.
Pull request overview
Adds a new Azure AI Foundry integration doc to clarify when to use FoundryAgent (connect to existing Foundry PromptAgent/HostedAgent) versus FoundryChatClient (direct model deployment access), addressing confusion from issue #5160.
Changes:
- Added a comparison of Foundry integration entry points (
FoundryAgent/RawFoundryAgentvsFoundryChatClient/RawFoundryChatClient). - Added usage guidance tables, examples, and environment variable/package references.
- Documented “raw vs recommended” variants and suggested scenarios.
- Fix FoundryChatClient example to use Message objects and response.text - Separate usage guidance for RawFoundryAgent and RawFoundryChatClient - Update Raw vs Recommended section to clarify actual layering - Fix scenario table to reference client_type parameter for raw agent
|
Copilot apply changes based on the comments in this thread |
|
@microsoft-github-policy-service agree |
|
@microsoft-github-policy-service agree company="microsoft" |
Message takes (role, contents=...) not (user_content=...).
Fixed: Message(user_content="Hello!") -> Message("user", "Hello!")
|
Evan Mattson (@moonbox3) a gentle nudge to give this a review; when you find time. |
Evan Mattson (moonbox3)
left a comment
There was a problem hiding this comment.
Thanks for the contribution. This GitHub Issue filed is for some internal tracking where we will add the doc to our Microsoft Learn Site docs pages, and not as a markdown file to the repo.
Add documentation explaining when to use FoundryAgent (connecting to existing Foundry agents) vs FoundryChatClient (direct model access).
This addresses the confusion raised in issue #5160.
Motivation and Context
Description
Contribution Checklist