docs: Add clarifying documentation for FoundryAgent vs FoundryChatClient#5161
Open
beyondszine wants to merge 4 commits intomicrosoft:mainfrom
Open
docs: Add clarifying documentation for FoundryAgent vs FoundryChatClient#5161beyondszine wants to merge 4 commits intomicrosoft:mainfrom
beyondszine wants to merge 4 commits intomicrosoft:mainfrom
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.
Author
|
@microsoft-github-policy-service agree company="microsoft" |
Contributor
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
Author
|
@copilot apply changes based on the comments in this thread |
|
@beyondszine the command you issued was incorrect. Please try again. Examples are: and |
Author
|
@microsoft-github-policy-service agree |
Author
|
@microsoft-github-policy-service agree company="microsoft" |
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.
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