microsoft-agents-copilotstudio-client 0.7.0.dev8__py3-none-any.whl → 0.7.0.dev12__py3-none-any.whl

microsoft_agents/copilotstudio/client/__init__.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agent_type import AgentType
 from .connection_settings import ConnectionSettings
 from .copilot_client import CopilotClient

microsoft_agents/copilotstudio/client/agent_type.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/copilotstudio/client/connection_settings.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Optional
 from .direct_to_engine_connection_settings_protocol import (
     DirectToEngineConnectionSettingsProtocol,
@@ -15,10 +18,22 @@ class ConnectionSettings(DirectToEngineConnectionSettingsProtocol):
         self,
         environment_id: str,
         agent_identifier: str,
-        cloud: Optional[PowerPlatformCloud],
-        copilot_agent_type: Optional[AgentType],
-        custom_power_platform_cloud: Optional[str],
+        cloud: Optional[PowerPlatformCloud] = None,
+        copilot_agent_type: Optional[AgentType] = None,
+        custom_power_platform_cloud: Optional[str] = None,
+        client_session_settings: Optional[dict] = None,
     ) -> 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.
+        """
+
         self.environment_id = environment_id
         self.agent_identifier = agent_identifier
 
@@ -30,3 +45,4 @@ class ConnectionSettings(DirectToEngineConnectionSettingsProtocol):
         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 {}

microsoft_agents/copilotstudio/client/copilot_client.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 import aiohttp
 from typing import AsyncIterable, Callable, Optional
 
@@ -9,6 +12,8 @@ from .power_platform_environment import PowerPlatformEnvironment
 
 
 class CopilotClient:
+    """A client for interacting with the Copilot service."""
+
     EVENT_STREAM_TYPE = "text/event-stream"
     APPLICATION_JSON_TYPE = "application/json"
 
@@ -28,8 +33,19 @@ class CopilotClient:
     async def post_request(
         self, url: str, data: dict, headers: dict
     ) -> AsyncIterable[Activity]:
-        async with aiohttp.ClientSession() as session:
+        """Send a POST request to the specified URL with the given data and headers.
+
+        :param url: The URL to which the POST request is sent.
+        :param data: The data to be sent in the POST request body.
+        :param headers: The headers to be included in the POST request.
+        :return: An asynchronous iterable of Activity objects received in the response.
+        """
+
+        async with aiohttp.ClientSession(
+            **self.settings.client_session_settings
+        ) as session:
             async with session.post(url, json=data, headers=headers) as response:
+
                 if response.status != 200:
                     # self.logger(f"Error sending request: {response.status}")
                     raise aiohttp.ClientError(
@@ -57,6 +73,12 @@ class CopilotClient:
     async def start_conversation(
         self, emit_start_conversation_event: bool = True
     ) -> AsyncIterable[Activity]:
+        """Start a new conversation and optionally emit a start conversation event.
+
+        :param emit_start_conversation_event: A boolean flag indicating whether to emit a start conversation event.
+        :return: An asynchronous iterable of Activity objects received in the response.
+        """
+
         url = PowerPlatformEnvironment.get_copilot_studio_connection_url(
             settings=self.settings
         )
@@ -73,6 +95,13 @@ class CopilotClient:
     async def ask_question(
         self, question: str, conversation_id: Optional[str] = None
     ) -> AsyncIterable[Activity]:
+        """Ask a question in the specified conversation.
+
+        :param question: The question to be asked.
+        :param conversation_id: The ID of the conversation in which the question is asked. If not provided, the current conversation ID is used.
+        :return: An asynchronous iterable of Activity objects received in the response.
+        """
+
         activity = Activity(
             type="message",
             text=question,
@@ -87,6 +116,12 @@ class CopilotClient:
     async def ask_question_with_activity(
         self, activity: Activity
     ) -> AsyncIterable[Activity]:
+        """Ask a question using an Activity object.
+
+        :param activity: The Activity object representing the question to be asked.
+        :return: An asynchronous iterable of Activity objects received in the response.
+        """
+
         if not activity:
             raise ValueError(
                 "CopilotClient.ask_question_with_activity: Activity cannot be None"

microsoft_agents/copilotstudio/client/direct_to_engine_connection_settings_protocol.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Protocol, Optional
 
 from .agent_type import AgentType

microsoft_agents/copilotstudio/client/execute_turn_request.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from microsoft_agents.activity import AgentsModel, Activity
 
 

microsoft_agents/copilotstudio/client/power_platform_cloud.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/copilotstudio/client/power_platform_environment.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from microsoft_agents.copilotstudio.client.errors import copilot_studio_errors
 from urllib.parse import urlparse, urlunparse
 from typing import Optional

{microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info → microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-copilotstudio-client
-Version: 0.7.0.dev8
+Version: 0.7.0.dev12
 Summary: A client library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-hosting-core==0.7.0.dev8
+Requires-Dist: microsoft-agents-hosting-core==0.7.0.dev12
 Dynamic: license-file
 Dynamic: requires-dist
 

microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/RECORD

@@ -0,0 +1,15 @@
+microsoft_agents/copilotstudio/client/__init__.py,sha256=iZXgc_os1Br-ZvQwixmR7zPRLu6tvhRW17_myMYj1D0,714
+microsoft_agents/copilotstudio/client/agent_type.py,sha256=1jX5-rxlpEUCXemlWLtaMEc2rA4uFX6yhUTVM5tqeg8,201
+microsoft_agents/copilotstudio/client/connection_settings.py,sha256=v0NWvuSwIoGdxHpQWXe9ZclXhv4VROR1stptoM7oPKc,1951
+microsoft_agents/copilotstudio/client/copilot_client.py,sha256=jQiBko9V1x9m3Il8mvwjuILy4vU7ksSD_rs6Y1KLwZc,5662
+microsoft_agents/copilotstudio/client/direct_to_engine_connection_settings_protocol.py,sha256=ACw1MUSHBSQVvlE30_bJGXKAbfWQ-c9Ob5mG38Rk2ss,880
+microsoft_agents/copilotstudio/client/execute_turn_request.py,sha256=vqRQbtr5LkE3IptJpepNkBzalnPB_rVOgVTqN8nlwaI,220
+microsoft_agents/copilotstudio/client/power_platform_cloud.py,sha256=QNNrxus-dmAnKlVGOCoi_DJw-5r716jd8j-AcJHVDnQ,560
+microsoft_agents/copilotstudio/client/power_platform_environment.py,sha256=LMZr4Z1BZfmMLMs_kfxYmkv4ad5Gt-yoWg7Hq0mzv2U,6923
+microsoft_agents/copilotstudio/client/errors/__init__.py,sha256=o-OHGAnaYY8diahW9rrRn18WNeLL2hnUVtlV20HWeh8,448
+microsoft_agents/copilotstudio/client/errors/error_resources.py,sha256=mhsmdShrHtUeMOuCi84a_vJmqyidbygArPdwM-mSHHw,1482
+microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/METADATA,sha256=MWwaYJnZqop_cBqC3N8fxXKhQShXyRKcAAYF1Cv0mws,9459
+microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
+microsoft_agents_copilotstudio_client-0.7.0.dev12.dist-info/RECORD,,

microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/RECORD

@@ -1,15 +0,0 @@
-microsoft_agents/copilotstudio/client/__init__.py,sha256=I--hf_7nZaw2xv_7Fm7UPrn-uk4ZF1pVTaLaSKfpuIA,619
-microsoft_agents/copilotstudio/client/agent_type.py,sha256=dhoU4sEoju8lInJX5LWf2AyNpyaW5lfGRN9BfL6TuYI,106
-microsoft_agents/copilotstudio/client/connection_settings.py,sha256=fG5q-Z-OizxMREdU3T499JSa88XufcVRnw3oMaGzHCY,1136
-microsoft_agents/copilotstudio/client/copilot_client.py,sha256=YuOi-aOt_gM-l7CYdcFvUG_n4DD_gz4Fca4vAml6Ykg,4159
-microsoft_agents/copilotstudio/client/direct_to_engine_connection_settings_protocol.py,sha256=JBBGSI5TfzO5QjTQpNORbX0blBY88jz7v9egtFd_7Yw,785
-microsoft_agents/copilotstudio/client/execute_turn_request.py,sha256=Gi8KPODVAaISjMtBbdbHvWSq56VAt_I7D9-U1YyEL00,125
-microsoft_agents/copilotstudio/client/power_platform_cloud.py,sha256=YrwAmxpeSuWpuQ1VnDc2_4m_r6T6sjbHMugBrIEF4iQ,465
-microsoft_agents/copilotstudio/client/power_platform_environment.py,sha256=es9KQ52usUyCPq0DSn-IKRxIv1fhnhBPAC6mmpYiENs,6828
-microsoft_agents/copilotstudio/client/errors/__init__.py,sha256=o-OHGAnaYY8diahW9rrRn18WNeLL2hnUVtlV20HWeh8,448
-microsoft_agents/copilotstudio/client/errors/error_resources.py,sha256=mhsmdShrHtUeMOuCi84a_vJmqyidbygArPdwM-mSHHw,1482
-microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/METADATA,sha256=xO4Iz05xhzh729ETJY5erARffzgjcqfphCWKbYhaiKY,9457
-microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
-microsoft_agents_copilotstudio_client-0.7.0.dev8.dist-info/RECORD,,