-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Add samples for Fabric IQ agent with synchronous and asynchronous cli… #47058
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.
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
+148
−1
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
69 changes: 69 additions & 0 deletions
69
sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_fabric_iq.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # pylint: disable=line-too-long,useless-suppression | ||
| # ------------------------------------ | ||
| # Copyright (c) Microsoft Corporation. | ||
| # Licensed under the MIT License. | ||
| # ------------------------------------ | ||
|
|
||
| """ | ||
| DESCRIPTION: | ||
| This sample demonstrates how to run a Prompt Agent that uses the | ||
| Fabric IQ preview tool with a synchronous client. | ||
|
|
||
| USAGE: | ||
| python sample_agent_fabric_iq.py | ||
|
|
||
| Before running the sample: | ||
|
|
||
| pip install "azure-ai-projects>=2.2.0" python-dotenv | ||
|
|
||
| Set these environment variables with your own values: | ||
| 1) FOUNDRY_PROJECT_ENDPOINT - The Azure AI Project endpoint, as found in the Overview | ||
| page of your Microsoft Foundry portal. | ||
| 2) FOUNDRY_MODEL_NAME - The deployment name of the AI model, as found under the "Name" column in | ||
| the "Models + endpoints" tab in your Microsoft Foundry project. | ||
| 3) FABRIC_IQ_PROJECT_CONNECTION_ID - The fully-qualified resource id of the Fabric IQ project connection. | ||
| 4) FABRIC_IQ_USER_INPUT - The natural-language question to send to the agent. | ||
| """ | ||
|
|
||
| import os | ||
| from dotenv import load_dotenv | ||
| from azure.identity import DefaultAzureCredential | ||
| from azure.ai.projects import AIProjectClient | ||
| from azure.ai.projects.models import PromptAgentDefinition, FabricIQPreviewTool | ||
|
|
||
| load_dotenv() | ||
|
|
||
| endpoint = os.environ["FOUNDRY_PROJECT_ENDPOINT"] | ||
|
|
||
| with ( | ||
| DefaultAzureCredential() as credential, | ||
| AIProjectClient(endpoint=endpoint, credential=credential) as project_client, | ||
| project_client.get_openai_client() as openai_client, | ||
| ): | ||
| tool_payload = FabricIQPreviewTool( | ||
| project_connection_id=os.environ["FABRIC_IQ_PROJECT_CONNECTION_ID"], | ||
| require_approval="never", | ||
| ) | ||
|
|
||
| agent = project_client.agents.create_version( | ||
| agent_name="MyAgent", | ||
| definition=PromptAgentDefinition( | ||
| model=os.environ["FOUNDRY_MODEL_NAME"], | ||
| instructions="Use the available Fabric IQ tools to answer questions and perform tasks.", | ||
| tools=[tool_payload], | ||
| ), | ||
| ) | ||
| print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})") | ||
|
|
||
| user_input = os.environ.get("FABRIC_IQ_USER_INPUT") or input("Enter your question:\n") | ||
|
|
||
| response = openai_client.responses.create( | ||
| input=user_input, | ||
| extra_body={"agent_reference": {"name": agent.name, "type": "agent_reference"}}, | ||
| ) | ||
|
|
||
| print(f"Agent response: {response.output_text}") | ||
|
|
||
| # Clean up the agent version so unused versions don't accumulate in the project. | ||
| project_client.agents.delete_version(agent_name=agent.name, agent_version=agent.version) | ||
| print("Agent deleted") | ||
76 changes: 76 additions & 0 deletions
76
sdk/ai/azure-ai-projects/samples/agents/tools/sample_agent_fabric_iq_async.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # pylint: disable=line-too-long,useless-suppression | ||
| # ------------------------------------ | ||
| # Copyright (c) Microsoft Corporation. | ||
| # Licensed under the MIT License. | ||
| # ------------------------------------ | ||
|
|
||
| """ | ||
| DESCRIPTION: | ||
| This sample demonstrates how to run a Prompt Agent that uses the | ||
| Fabric IQ preview tool with an asynchronous client. | ||
|
|
||
| USAGE: | ||
| python sample_agent_fabric_iq_async.py | ||
|
|
||
| Before running the sample: | ||
|
|
||
| pip install "azure-ai-projects>=2.2.0" python-dotenv aiohttp | ||
|
|
||
| Set these environment variables with your own values: | ||
| 1) FOUNDRY_PROJECT_ENDPOINT - The Azure AI Project endpoint, as found in the Overview | ||
| page of your Microsoft Foundry portal. | ||
| 2) FOUNDRY_MODEL_NAME - The deployment name of the AI model, as found under the "Name" column in | ||
| the "Models + endpoints" tab in your Microsoft Foundry project. | ||
| 3) FABRIC_IQ_PROJECT_CONNECTION_ID - The fully-qualified resource id of the Fabric IQ project connection. | ||
| 4) FABRIC_IQ_USER_INPUT - The natural-language question to send to the agent. | ||
| """ | ||
|
|
||
| import os | ||
| import asyncio | ||
| from dotenv import load_dotenv | ||
| from azure.identity.aio import DefaultAzureCredential | ||
| from azure.ai.projects.aio import AIProjectClient | ||
| from azure.ai.projects.models import PromptAgentDefinition, FabricIQPreviewTool | ||
|
|
||
| load_dotenv() | ||
|
|
||
| endpoint = os.environ["FOUNDRY_PROJECT_ENDPOINT"] | ||
|
|
||
|
|
||
| async def main(): | ||
| async with ( | ||
| DefaultAzureCredential() as credential, | ||
| AIProjectClient(endpoint=endpoint, credential=credential) as project_client, | ||
| project_client.get_openai_client() as openai_client, | ||
| ): | ||
| tool_payload = FabricIQPreviewTool( | ||
| project_connection_id=os.environ["FABRIC_IQ_PROJECT_CONNECTION_ID"], | ||
| require_approval="never", | ||
| ) | ||
|
|
||
| agent = await project_client.agents.create_version( | ||
| agent_name="MyAgent", | ||
| definition=PromptAgentDefinition( | ||
| model=os.environ["FOUNDRY_MODEL_NAME"], | ||
| instructions="Use the available Fabric IQ tools to answer questions and perform tasks.", | ||
| tools=[tool_payload], | ||
| ), | ||
| ) | ||
| print(f"Agent created (id: {agent.id}, name: {agent.name}, version: {agent.version})") | ||
|
|
||
| user_input = os.environ.get("FABRIC_IQ_USER_INPUT") or input("Enter your question:\n") | ||
|
|
||
| response = await openai_client.responses.create( | ||
| input=user_input, | ||
| extra_body={"agent_reference": {"name": agent.name, "type": "agent_reference"}}, | ||
| ) | ||
|
|
||
| print(f"Agent response: {response.output_text}") | ||
|
|
||
| # Clean up the agent version so unused versions don't accumulate in the project. | ||
| await project_client.agents.delete_version(agent_name=agent.name, agent_version=agent.version) | ||
| print("Agent deleted") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| asyncio.run(main()) |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the enum value
MCPToolRequireApproval.never.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
have to be a string for our scenario