microsoft-agents-copilotstudio-client 0.8.0.dev3__tar.gz → 0.9.0.dev1__tar.gz

microsoft_agents_copilotstudio_client-0.9.0.dev1/PKG-INFO

@@ -0,0 +1,485 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-copilotstudio-client
+Version: 0.9.0.dev1
+Summary: A client library for Microsoft Agents
+Author: Microsoft Corporation
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: microsoft-agents-hosting-core==0.9.0.dev1
+Dynamic: license-file
+Dynamic: requires-dist
+
+# Microsoft Agents Copilot Studio Client
+
+[![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/)
+
+The Copilot Studio Client is for connecting to and interacting with agents created in Microsoft Copilot Studio. This library allows you to integrate Copilot Studio agents into your Python applications.
+
+This client library provides a direct connection to Copilot Studio agents, bypassing traditional chat channels. It's perfect for integrating AI conversations into your applications, building custom UIs, or creating agent-to-agent communication flows.
+
+# What is this?
+This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.
+
+## Release Notes
+<table style="width:100%">
+  <tr>
+    <th style="width:20%">Version</th>
+    <th style="width:20%">Date</th>
+    <th style="width:60%">Release Notes</th>
+  </tr>
+  <tr>
+    <td>0.8.0</td>
+    <td>2026-02-23</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md#microsoft-365-agents-sdk-for-python---release-notes-v080">
+        0.8.0 Release Notes
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>0.7.0</td>
+    <td>2026-01-21</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md#microsoft-365-agents-sdk-for-python---release-notes-v070">
+        0.7.0 Release Notes
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>0.6.1</td>
+    <td>2025-12-01</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md#microsoft-365-agents-sdk-for-python---release-notes-v061">
+        0.6.1 Release Notes
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>0.6.0</td>
+    <td>2025-11-18</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md#microsoft-365-agents-sdk-for-python---release-notes-v060">
+        0.6.0 Release Notes
+      </a>
+    </td>
+  </tr>
+  <tr>
+    <td>0.5.0</td>
+    <td>2025-10-22</td>
+    <td>
+      <a href="https://github.com/microsoft/Agents-for-python/blob/main/changelog.md#microsoft-365-agents-sdk-for-python---release-notes-v050">
+        0.5.0 Release Notes
+      </a>
+    </td>
+  </tr>
+</table>
+
+## Packages Overview
+
+We offer the following PyPI packages to create conversational experiences based on Agents:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `microsoft-agents-activity` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-activity)](https://pypi.org/project/microsoft-agents-activity/) | Types and validators implementing the Activity protocol spec. |
+| `microsoft-agents-hosting-core` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-core)](https://pypi.org/project/microsoft-agents-hosting-core/) | Core library for Microsoft Agents hosting. |
+| `microsoft-agents-hosting-aiohttp` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-aiohttp)](https://pypi.org/project/microsoft-agents-hosting-aiohttp/) | Configures aiohttp to run the Agent. |
+| `microsoft-agents-hosting-teams` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-hosting-teams)](https://pypi.org/project/microsoft-agents-hosting-teams/) | Provides classes to host an Agent for Teams. |
+| `microsoft-agents-storage-blob` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-blob)](https://pypi.org/project/microsoft-agents-storage-blob/) | Extension to use Azure Blob as storage. |
+| `microsoft-agents-storage-cosmos` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-storage-cosmos)](https://pypi.org/project/microsoft-agents-storage-cosmos/) | Extension to use CosmosDB as storage. |
+| `microsoft-agents-authentication-msal` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-authentication-msal)](https://pypi.org/project/microsoft-agents-authentication-msal/) | MSAL-based authentication for Microsoft Agents. |
+
+Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:
+
+| Package Name | PyPI Version | Description |
+|--------------|-------------|-------------|
+| `microsoft-agents-copilotstudio-client` | [![PyPI](https://img.shields.io/pypi/v/microsoft-agents-copilotstudio-client)](https://pypi.org/project/microsoft-agents-copilotstudio-client/) | Direct to Engine client to interact with Agents created in CopilotStudio |
+
+
+## Installation
+
+```bash
+pip install microsoft-agents-copilotstudio-client
+```
+
+## Quick Start
+
+### Basic Setup
+
+#### Standard Environment-Based Connection
+
+Code below from the [main.py in the Copilot Studio Client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/src/main.py)
+```python
+def create_client():
+    settings = ConnectionSettings(
+        environment_id=environ.get("COPILOTSTUDIOAGENT__ENVIRONMENTID"),
+        agent_identifier=environ.get("COPILOTSTUDIOAGENT__SCHEMANAME"),
+        cloud=None,
+        copilot_agent_type=None,
+        custom_power_platform_cloud=None,
+    )
+    token = acquire_token(
+        settings,
+        app_client_id=environ.get("COPILOTSTUDIOAGENT__AGENTAPPID"),
+        tenant_id=environ.get("COPILOTSTUDIOAGENT__TENANTID"),
+    )
+    copilot_client = CopilotClient(settings, token)
+    return copilot_client
+```
+
+#### DirectConnect URL Mode (Simplified Setup)
+
+For simplified setup, you can use a DirectConnect URL instead of environment-based configuration:
+
+```python
+def create_client_direct():
+    settings = ConnectionSettings(
+        environment_id="",  # Not needed with DirectConnect URL
+        agent_identifier="",  # Not needed with DirectConnect URL
+        direct_connect_url="https://api.powerplatform.com/copilotstudio/dataverse-backed/authenticated/bots/your-bot-id"
+    )
+    token = acquire_token(...)
+    copilot_client = CopilotClient(settings, token)
+    return copilot_client
+```
+
+#### Advanced Configuration Options
+
+```python
+settings = ConnectionSettings(
+    environment_id="your-env-id",
+    agent_identifier="your-agent-id",
+    cloud=PowerPlatformCloud.PROD,
+    copilot_agent_type=AgentType.PUBLISHED,
+    custom_power_platform_cloud=None,
+    direct_connect_url=None,  # Optional: Direct URL to agent
+    use_experimental_endpoint=False,  # Optional: Enable experimental features
+    enable_diagnostics=False,  # Optional: Enable diagnostic logging (logs HTTP details)
+    client_session_settings={"timeout": aiohttp.ClientTimeout(total=60)}  # Optional: aiohttp settings
+)
+```
+
+**Diagnostic Logging Details**:
+When `enable_diagnostics=True`, the CopilotClient logs detailed HTTP communication using Python's `logging` module at the `DEBUG` level:
+- Pre-request: Logs the full request URL (`>>> SEND TO {url}`)
+- Post-response: Logs all HTTP response headers in a formatted table
+- Errors: Logs error messages with status codes
+
+To see diagnostic output, configure your Python logging:
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+```
+
+**Experimental Endpoint Details**:
+When `use_experimental_endpoint=True`, the CopilotClient will automatically capture and use the experimental endpoint URL from the first response:
+- The server returns the experimental endpoint in the `x-ms-d2e-experimental` response header
+- Once captured, this URL is stored in `settings.direct_connect_url` and used for all subsequent requests
+- This feature is only active when `use_experimental_endpoint=True` AND `direct_connect_url` is not already set
+- The experimental endpoint allows access to pre-release features and optimizations
+
+### Start a Conversation
+
+#### Simple Start
+
+The code below is summarized from the [main.py in the Copilot Studio Client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/src/main.py). See that sample for complete & working code.
+
+```python
+copilot_client = create_client()
+async for activity in copilot_client.start_conversation(emit_start_conversation_event=True):
+    if activity.type == ActivityTypes.message:
+        print(f"\n{activity.text}")
+
+# Ask questions
+async for reply in copilot_client.ask_question("Who are you?", conversation_id):
+    if reply.type == ActivityTypes.message:
+        print(f"\n{reply.text}")
+```
+
+#### Start with Advanced Options (Locale Support)
+
+```python
+from microsoft_agents.copilotstudio.client import StartRequest
+
+# Create a start request with locale
+start_request = StartRequest(
+    emit_start_conversation_event=True,
+    locale="en-US",  # Optional: specify conversation locale
+    conversation_id="custom-conv-id"  # Optional: provide your own conversation ID
+)
+
+async for activity in copilot_client.start_conversation_with_request(start_request):
+    if activity.type == ActivityTypes.message:
+        print(f"\n{activity.text}")
+```
+
+### Send Activities
+
+#### Send a Custom Activity
+
+```python
+from microsoft_agents.activity import Activity
+
+activity = Activity(
+    type="message",
+    text="Hello, agent!",
+    conversation={"id": conversation_id}
+)
+
+async for reply in copilot_client.send_activity(activity):
+    print(f"Response: {reply.text}")
+```
+
+#### Execute with Explicit Conversation ID
+
+```python
+# Execute an activity with a specific conversation ID
+activity = Activity(type="message", text="What's the weather?")
+
+async for reply in copilot_client.execute(conversation_id="conv-123", activity=activity):
+    print(f"Response: {reply.text}")
+```
+
+### Subscribe to Conversation Events
+
+For real-time event streaming with resumption support:
+
+```python
+from microsoft_agents.copilotstudio.client import SubscribeEvent
+
+# Subscribe to conversation events
+async for subscribe_event in copilot_client.subscribe(
+    conversation_id="conv-123",
+    last_received_event_id=None  # Optional: resume from last event
+):
+    activity = subscribe_event.activity
+    event_id = subscribe_event.event_id  # Use for resumption
+
+    if activity.type == ActivityTypes.message:
+        print(f"[{event_id}] {activity.text}")
+```
+
+### Environment Variables
+
+Set up your `.env` file with the following options:
+
+#### Standard Environment-Based Configuration
+
+```bash
+# Required (unless using DIRECT_CONNECT_URL)
+ENVIRONMENT_ID=your-power-platform-environment-id
+AGENT_IDENTIFIER=your-copilot-studio-agent-id
+APP_CLIENT_ID=your-azure-app-client-id
+TENANT_ID=your-azure-tenant-id
+
+# Optional Cloud Configuration
+CLOUD=PROD  # Options: PROD, GOV, HIGH, DOD, MOONCAKE, DEV, TEST, etc.
+COPILOT_AGENT_TYPE=PUBLISHED  # Options: PUBLISHED, PREBUILT
+CUSTOM_POWER_PLATFORM_CLOUD=https://custom.cloud.com
+```
+
+#### DirectConnect URL Configuration (Alternative)
+
+```bash
+# Required for DirectConnect mode
+DIRECT_CONNECT_URL=https://api.powerplatform.com/copilotstudio/dataverse-backed/authenticated/bots/your-bot-id
+APP_CLIENT_ID=your-azure-app-client-id
+TENANT_ID=your-azure-tenant-id
+
+# Optional
+CLOUD=PROD  # Used for token audience resolution
+```
+
+#### Advanced Options
+
+```bash
+# Experimental and diagnostic features
+USE_EXPERIMENTAL_ENDPOINT=false  # Enable automatic experimental endpoint capture
+ENABLE_DIAGNOSTICS=false  # Enable diagnostic logging (logs HTTP requests/responses)
+```
+
+**Experimental Endpoint**: When `USE_EXPERIMENTAL_ENDPOINT=true`, the client automatically captures and uses the experimental endpoint URL from the server's `x-ms-d2e-experimental` response header. This feature:
+- Only activates when `direct_connect_url` is not already set
+- Captures the URL from the first response and stores it for all subsequent requests
+- Provides access to pre-release features and performance optimizations
+- Useful for testing new capabilities before general availability
+
+**Diagnostic Logging**: When `ENABLE_DIAGNOSTICS=true` or `enable_diagnostics=True`, the client will log detailed HTTP request and response information including:
+- Request URLs before sending
+- All response headers with their values
+- Error messages for failed requests
+
+This is useful for debugging connection issues, authentication problems, or understanding the communication flow with Copilot Studio. Diagnostic logs use Python's standard `logging` module at the `DEBUG` level.
+
+#### Using Environment Variables in Code
+
+The `ConnectionSettings.populate_from_environment()` helper method automatically loads these variables:
+
+```python
+from microsoft_agents.copilotstudio.client import ConnectionSettings
+
+# Automatically loads from environment variables
+settings_dict = ConnectionSettings.populate_from_environment()
+settings = ConnectionSettings(**settings_dict)
+```
+
+## Features
+
+### Core Capabilities
+
+✅ **Real-time streaming** - Server-sent events for live responses
+✅ **Multi-cloud support** - Works across all Power Platform clouds (PROD, GOV, HIGH, DOD, MOONCAKE, etc.)
+✅ **Rich content** - Support for cards, actions, and attachments
+✅ **Conversation management** - Maintain context across interactions
+✅ **Custom activities** - Send structured data to agents
+✅ **Async/await** - Modern Python async support
+
+### Advanced Features
+
+✅ **DirectConnect URLs** - Simplified connection with direct bot URLs
+✅ **Locale support** - Specify conversation language with `StartRequest`
+✅ **Event subscription** - Subscribe to conversation events with SSE resumption
+✅ **Multiple connection modes** - Environment-based or DirectConnect URL
+✅ **Token audience resolution** - Automatic cloud detection from URLs
+✅ **User-Agent tracking** - Automatic SDK version and platform headers
+✅ **Environment configuration** - Automatic loading from environment variables
+✅ **Experimental endpoints** - Toggle experimental API features
+✅ **Diagnostic logging** - HTTP request/response logging for debugging and troubleshooting
+
+### API Methods
+
+| Method | Description |
+|--------|-------------|
+| `start_conversation()` | Start a new conversation with basic options |
+| `start_conversation_with_request()` | Start with advanced options (locale, custom conversation ID) |
+| `ask_question()` | Send a text question to the agent |
+| `ask_question_with_activity()` | Send a custom Activity object |
+| `send_activity()` | Send any activity (alias for ask_question_with_activity) |
+| `execute()` | Execute an activity with explicit conversation ID |
+| `subscribe()` | Subscribe to conversation events with resumption support |
+
+### Configuration Models
+
+| Class | Description |
+|-------|-------------|
+| `ConnectionSettings` | Main configuration class with all connection options |
+| `StartRequest` | Advanced start options (locale, conversation ID) |
+| `SubscribeEvent` | Event wrapper with activity and SSE event ID |
+| `PowerPlatformCloud` | Enum for cloud environments |
+| `AgentType` | Enum for agent types (PUBLISHED, PREBUILT) |
+| `UserAgentHelper` | Utility for generating user-agent headers |
+
+## Connection Modes
+
+The client supports two connection modes:
+
+### 1. Environment-Based Connection (Standard)
+
+Uses environment ID and agent identifier to construct the connection URL:
+
+```python
+settings = ConnectionSettings(
+    environment_id="aaaabbbb-1111-2222-3333-ccccddddeeee",
+    agent_identifier="cr123_myagent"
+)
+```
+
+**URL Pattern:**
+`https://{env-prefix}.{env-suffix}.environment.api.powerplatform.com/copilotstudio/dataverse-backed/authenticated/bots/{agent-id}/conversations`
+
+### 2. DirectConnect URL Mode (Simplified)
+
+Uses a direct URL to the agent, bypassing environment resolution:
+
+```python
+settings = ConnectionSettings(
+    environment_id="",
+    agent_identifier="",
+    direct_connect_url="https://api.powerplatform.com/copilotstudio/dataverse-backed/authenticated/bots/cr123_myagent"
+)
+```
+
+**Benefits:**
+- Simpler configuration with single URL
+- Automatic cloud detection for token audience
+- Works across environments without environment ID lookup
+- Useful for multi-tenant scenarios
+
+## Token Audience Resolution
+
+The client automatically determines the correct token audience:
+
+```python
+# For environment-based connections
+audience = PowerPlatformEnvironment.get_token_audience(settings)
+# Returns: https://api.powerplatform.com/.default
+
+# For DirectConnect URLs
+audience = PowerPlatformEnvironment.get_token_audience(
+    settings=ConnectionSettings("", "", direct_connect_url="https://api.gov.powerplatform.microsoft.us/...")
+)
+# Returns: https://api.gov.powerplatform.microsoft.us/.default
+```
+
+## Troubleshooting
+
+### Common Issues
+
+**Authentication failed**
+- Verify your app is registered in Azure AD
+- Check that token has the correct audience scope (use `PowerPlatformEnvironment.get_token_audience()`)
+- Ensure your app has permissions to the Power Platform environment
+- For DirectConnect URLs, verify cloud setting matches the URL domain
+
+**Agent not found**
+- Verify the environment ID and agent identifier
+- Check that the agent is published and accessible
+- Confirm you're using the correct cloud setting
+- For DirectConnect URLs, ensure the URL is correct and complete
+
+**Connection timeout**
+- Check network connectivity to Power Platform
+- Verify firewall settings allow HTTPS traffic
+- Try a different cloud region if available
+- Check if `client_session_settings` timeout is appropriate
+
+**Invalid DirectConnect URL**
+- Ensure URL includes scheme (https://)
+- Verify URL format matches expected pattern
+- Check for trailing slashes (automatically normalized)
+- Confirm URL points to the correct cloud environment
+
+## Requirements
+
+- Python 3.10+ (supports 3.10, 3.11, 3.12, 3.13, 3.14)
+- Valid Azure AD app registration
+- Access to Microsoft Power Platform environment
+- Published Copilot Studio agent
+
+# Quick Links
+
+- 📦 [All SDK Packages on PyPI](https://pypi.org/search/?q=microsoft-agents)
+- 📖 [Complete Documentation](https://aka.ms/agents)
+- 💡 [Python Samples Repository](https://github.com/microsoft/Agents/tree/main/samples/python)
+- 🐛 [Report Issues](https://github.com/microsoft/Agents-for-python/issues)
+
+# Sample Applications
+
+|Name|Description|README|
+|----|----|----|
+|Quickstart|Simplest agent|[Quickstart](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/README.md)|
+|Auto Sign In|Simple OAuth agent using Graph and GitHub|[auto-signin](https://github.com/microsoft/Agents/blob/main/samples/python/auto-signin/README.md)|
+|OBO Authorization|OBO flow to access a Copilot Studio Agent|[obo-authorization](https://github.com/microsoft/Agents/blob/main/samples/python/obo-authorization/README.md)|
+|Semantic Kernel Integration|A weather agent built with Semantic Kernel|[semantic-kernel-multiturn](https://github.com/microsoft/Agents/blob/main/samples/python/semantic-kernel-multiturn/README.md)|
+|Streaming Agent|Streams OpenAI responses|[azure-ai-streaming](https://github.com/microsoft/Agents/blob/main/samples/python/azureai-streaming/README.md)|
+|Copilot Studio Client|Console app to consume a Copilot Studio Agent|[copilotstudio-client](https://github.com/microsoft/Agents/blob/main/samples/python/copilotstudio-client/README.md)|
+|Cards Agent|Agent that uses rich cards to enhance conversation design |[cards](https://github.com/microsoft/Agents/blob/main/samples/python/cards/README.md)|

microsoft_agents_copilotstudio_client-0.9.0.dev1/VERSION.txt

@@ -0,0 +1 @@
+0.9.0.dev1

{microsoft_agents_copilotstudio_client-0.8.0.dev3 → microsoft_agents_copilotstudio_client-0.9.0.dev1}/microsoft_agents/copilotstudio/client/__init__.py

@@ -4,19 +4,31 @@
 from .agent_type import AgentType
 from .connection_settings import ConnectionSettings
 from .copilot_client import CopilotClient
+from .copilot_client_protocol import CopilotClientProtocol
 from .direct_to_engine_connection_settings_protocol import (
     DirectToEngineConnectionSettingsProtocol,
 )
 from .execute_turn_request import ExecuteTurnRequest
 from .power_platform_cloud import PowerPlatformCloud
 from .power_platform_environment import PowerPlatformEnvironment
+from .start_request import StartRequest
+from .subscribe_event import SubscribeEvent
+from .subscribe_request import SubscribeRequest
+from .subscribe_response import SubscribeResponse
+from .user_agent_helper import UserAgentHelper
 
 __all__ = [
     "AgentType",
     "ConnectionSettings",
     "CopilotClient",
+    "CopilotClientProtocol",
     "DirectToEngineConnectionSettingsProtocol",
     "ExecuteTurnRequest",
     "PowerPlatformCloud",
     "PowerPlatformEnvironment",
+    "StartRequest",
+    "SubscribeEvent",
+    "SubscribeRequest",
+    "SubscribeResponse",
+    "UserAgentHelper",
 ]

microsoft_agents_copilotstudio_client-0.9.0.dev1/microsoft_agents/copilotstudio/client/connection_settings.py

@@ -0,0 +1,135 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from os import environ
+from typing import Dict, Optional, Any
+from .direct_to_engine_connection_settings_protocol import (
+    DirectToEngineConnectionSettingsProtocol,
+)
+from .power_platform_cloud import PowerPlatformCloud
+from .agent_type import AgentType
+
+
+class ConnectionSettings(DirectToEngineConnectionSettingsProtocol):
+    """
+    Connection settings for the DirectToEngineConnectionConfiguration.
+    """
+
+    def __init__(
+        self,
+        environment_id: str,
+        agent_identifier: str,
+        cloud: Optional[PowerPlatformCloud] = None,
+        copilot_agent_type: Optional[AgentType] = None,
+        custom_power_platform_cloud: Optional[str] = None,
+        client_session_settings: Optional[dict] = None,
+        direct_connect_url: Optional[str] = None,
+        use_experimental_endpoint: bool = False,
+        enable_diagnostics: bool = False,
+    ) -> None:
+        """Initialize connection settings.
+
+        :param environment_id: The ID of the environment to connect to.
+        :param agent_identifier: The identifier of the agent to use for the connection.
+        :param cloud: The PowerPlatformCloud to use for the connection.
+        :param copilot_agent_type: The AgentType to use for the Copilot.
+        :param custom_power_platform_cloud: The custom PowerPlatformCloud URL.
+        :param client_session_settings: Additional arguments for initialization
+            of the underlying Aiohttp ClientSession.
+        :param direct_connect_url: Direct connection URL override.
+        :param use_experimental_endpoint: Flag to enable experimental endpoint.
+        :param enable_diagnostics: Flag to enable diagnostics.
+        """
+
+        self.environment_id = environment_id
+        self.agent_identifier = agent_identifier
+
+        if not self.environment_id and not direct_connect_url:
+            raise ValueError("Environment ID or Direct Connect URL must be provided")
+        if not self.agent_identifier and not direct_connect_url:
+            raise ValueError("Agent Identifier or Direct Connect URL must be provided")
+
+        self.cloud = cloud or PowerPlatformCloud.PROD
+        self.copilot_agent_type = copilot_agent_type or AgentType.PUBLISHED
+        self.custom_power_platform_cloud = custom_power_platform_cloud
+        self.client_session_settings = client_session_settings or {}
+        self.direct_connect_url = direct_connect_url
+        self.use_experimental_endpoint = use_experimental_endpoint
+        self.enable_diagnostics = enable_diagnostics
+
+    @staticmethod
+    def populate_from_environment(
+        environment_id: Optional[str] = None,
+        agent_identifier: Optional[str] = None,
+        cloud: Optional[PowerPlatformCloud] = None,
+        copilot_agent_type: Optional[AgentType] = None,
+        custom_power_platform_cloud: Optional[str] = None,
+        direct_connect_url: Optional[str] = None,
+        use_experimental_endpoint: Optional[bool] = None,
+        enable_diagnostics: Optional[bool] = None,
+    ) -> Dict[str, Any]:
+        """
+        Populate connection settings from environment variables.
+
+        This method reads configuration values from environment variables
+        and returns them as a dictionary suitable for passing to ConnectionSettings.__init__().
+
+        :param environment_id: Optional override for ENVIRONMENT_ID env var.
+        :param agent_identifier: Optional override for AGENT_IDENTIFIER env var.
+        :param cloud: Optional override for CLOUD env var.
+        :param copilot_agent_type: Optional override for COPILOT_AGENT_TYPE env var.
+        :param custom_power_platform_cloud: Optional override for CUSTOM_POWER_PLATFORM_CLOUD env var.
+        :param direct_connect_url: Optional override for DIRECT_CONNECT_URL env var.
+        :param use_experimental_endpoint: Optional override for USE_EXPERIMENTAL_ENDPOINT env var.
+        :param enable_diagnostics: Optional override for ENABLE_DIAGNOSTICS env var.
+        :return: Dictionary of connection settings.
+        """
+        # Read from environment variables with provided overrides
+        env_id = environment_id or environ.get("ENVIRONMENT_ID", "")
+        agent_id = agent_identifier or environ.get("AGENT_IDENTIFIER", "")
+
+        # Handle cloud enum
+        cloud_value = cloud
+        if cloud_value is None:
+            cloud_str = environ.get("CLOUD", "PROD")
+            try:
+                cloud_value = PowerPlatformCloud[cloud_str]
+            except KeyError:
+                cloud_value = PowerPlatformCloud.PROD
+
+        # Handle copilot agent type enum
+        agent_type_value = copilot_agent_type
+        if agent_type_value is None:
+            agent_type_str = environ.get("COPILOT_AGENT_TYPE", "PUBLISHED")
+            try:
+                agent_type_value = AgentType[agent_type_str]
+            except KeyError:
+                agent_type_value = AgentType.PUBLISHED
+
+        # Handle other settings
+        custom_cloud = custom_power_platform_cloud or environ.get(
+            "CUSTOM_POWER_PLATFORM_CLOUD", None
+        )
+        direct_url = direct_connect_url or environ.get("DIRECT_CONNECT_URL", None)
+
+        # Handle boolean flags
+        exp_endpoint = use_experimental_endpoint
+        if exp_endpoint is None:
+            exp_endpoint = (
+                environ.get("USE_EXPERIMENTAL_ENDPOINT", "false").lower() == "true"
+            )
+
+        diagnostics = enable_diagnostics
+        if diagnostics is None:
+            diagnostics = environ.get("ENABLE_DIAGNOSTICS", "false").lower() == "true"
+
+        return {
+            "environment_id": env_id,
+            "agent_identifier": agent_id,
+            "cloud": cloud_value,
+            "copilot_agent_type": agent_type_value,
+            "custom_power_platform_cloud": custom_cloud,
+            "direct_connect_url": direct_url,
+            "use_experimental_endpoint": exp_endpoint,
+            "enable_diagnostics": diagnostics,
+        }