mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
a2856d3b92
* restructure: Python samples into progressive 01-05 layout - 01-get-started/: 6 numbered steps (hello agent → hosting) - 02-agents/: all agent concept samples (tools, middleware, providers, etc.) - 03-workflows/: ALL existing workflow samples preserved as-is - 04-hosting/: azure-functions, durabletask, a2a - 05-end-to-end/: demos, evaluation, hosted agents - Old files moved to _to_delete/ for review - Added AGENTS.md with structure documentation - autogen-migration/ and semantic-kernel-migration/ preserved at root * fix: switch to AzureOpenAI Foundry, fix CI failures - Switch all 01-get-started samples to AzureOpenAIResponsesClient with Azure AI Foundry project endpoint (AZURE_AI_PROJECT_ENDPOINT + AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME + AzureCliCredential) - Add _to_delete/ and 05-end-to-end/ to pyrightconfig.samples.json excludes - Fix test paths in packages/ that referenced old getting_started/ dirs: durabletask conftest + streaming test, azurefunctions conftest, devui conftest + capture_messages + openai_sdk_integration - Fix workflow_as_agent_human_in_the_loop.py import (sibling import) - Update hosting READMEs and tool comment paths - Replace root README.md with new structure overview - Update AGENTS.md to document Azure OpenAI Foundry as default provider * cleanup: remove _to_delete folder, copy resource files to active dirs All files in _to_delete/ were either: - Exact duplicates of files in the new structure (240 files) - Same file with only comment path updates (100 files) - One import-fix diff (workflow_as_agent_human_in_the_loop.py) - One superseded minimal_sample.py Resource files (sample.pdf, countries.json, employees.pdf, weather.json) copied to 02-agents/sample_assets/ and 02-agents/resources/ since active samples reference them. * fix: address PR review comments, centralize resources, remove root duplicates - Fix type annotation in 04_memory.py (string union -> proper types) - Fix old sample paths in observability files - Fix grammar/spelling in observability samples - Move sample_assets/ and resources/ to shared/ folder - Remove 8 duplicate observability files from 02-agents root - Update resource path references in multimodal_input and provider samples * fix: update broken links from old getting_started paths to new structure - Update relative paths in READMEs: getting_started/ → 01-get-started/, 02-agents/, 03-workflows/, 04-hosting/, 05-end-to-end/ - Fix absolute GitHub URLs in package READMEs - Fix broken link in ollama package README * fix: convert absolute GitHub URLs to relative paths for link checker Absolute URLs to python/samples/ on main branch 404 until PR merges. Converted to relative paths that linkspector can verify locally. * fix: update link for handoff sample moved to orchestrations/ * fix: update chatkit-integration README path from demos/ to 05-end-to-end/ * fix: update broken links in orchestrations README to match flat directory structure
98 lines
3.2 KiB
Markdown
98 lines
3.2 KiB
Markdown
# Get Started with Microsoft Agent Framework Copilot Studio
|
|
|
|
Please install this package via pip:
|
|
|
|
```bash
|
|
pip install agent-framework-copilotstudio --pre
|
|
```
|
|
|
|
## Copilot Studio Agent
|
|
|
|
The Copilot Studio agent enables integration with Microsoft Copilot Studio, allowing you to interact with published copilots through the Agent Framework.
|
|
|
|
### Prerequisites
|
|
|
|
Before using the Copilot Studio agent, you need:
|
|
|
|
1. **Copilot Studio Environment**: Access to a Microsoft Copilot Studio environment with a published copilot
|
|
2. **App Registration**: An Azure AD App Registration with appropriate permissions for Power Platform API
|
|
3. **Environment Configuration**: Set the required environment variables or pass them as parameters
|
|
|
|
### Environment Variables
|
|
|
|
The following environment variables are used for configuration:
|
|
|
|
- `COPILOTSTUDIOAGENT__ENVIRONMENTID` - Your Copilot Studio environment ID
|
|
- `COPILOTSTUDIOAGENT__SCHEMANAME` - Your copilot's agent identifier/schema name
|
|
- `COPILOTSTUDIOAGENT__AGENTAPPID` - Your App Registration client ID
|
|
- `COPILOTSTUDIOAGENT__TENANTID` - Your Azure AD tenant ID
|
|
|
|
### Basic Usage Example
|
|
|
|
```python
|
|
import asyncio
|
|
from agent_framework.microsoft import CopilotStudioAgent
|
|
|
|
async def main():
|
|
# Create agent using environment variables
|
|
agent = CopilotStudioAgent()
|
|
|
|
# Run a simple query
|
|
result = await agent.run("What is the capital of France?")
|
|
print(result)
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Explicit Configuration Example
|
|
|
|
```python
|
|
import asyncio
|
|
import os
|
|
from agent_framework.microsoft import CopilotStudioAgent, acquire_token
|
|
from microsoft_agents.copilotstudio.client import ConnectionSettings, CopilotClient, PowerPlatformCloud, AgentType
|
|
|
|
async def main():
|
|
# Acquire authentication token
|
|
token = acquire_token(
|
|
client_id=os.environ["COPILOTSTUDIOAGENT__AGENTAPPID"],
|
|
tenant_id=os.environ["COPILOTSTUDIOAGENT__TENANTID"]
|
|
)
|
|
|
|
# Create connection settings
|
|
settings = ConnectionSettings(
|
|
environment_id=os.environ["COPILOTSTUDIOAGENT__ENVIRONMENTID"],
|
|
agent_identifier=os.environ["COPILOTSTUDIOAGENT__SCHEMANAME"],
|
|
cloud=PowerPlatformCloud.PROD,
|
|
copilot_agent_type=AgentType.PUBLISHED,
|
|
custom_power_platform_cloud=None
|
|
)
|
|
|
|
# Create client and agent
|
|
client = CopilotClient(settings=settings, token=token)
|
|
agent = CopilotStudioAgent(client=client)
|
|
|
|
# Run a query
|
|
result = await agent.run("What is the capital of Italy?")
|
|
print(result)
|
|
|
|
asyncio.run(main())
|
|
```
|
|
|
|
### Authentication
|
|
|
|
The package uses MSAL (Microsoft Authentication Library) for authentication with interactive flows when needed. Ensure your App Registration has:
|
|
|
|
- **API Permissions**: Power Platform API permissions (https://api.powerplatform.com/.default)
|
|
- **Redirect URIs**: Configured appropriately for your authentication method
|
|
- **Public Client Flows**: Enabled if using interactive authentication
|
|
|
|
### Examples
|
|
|
|
For more comprehensive examples, see the [Copilot Studio examples](../../samples/02-agents/providers/copilotstudio/) which demonstrate:
|
|
|
|
- Basic non-streaming and streaming execution
|
|
- Explicit settings and manual token acquisition
|
|
- Different authentication patterns
|
|
- Error handling and troubleshooting
|