agent-framework-copilotstudio 1.0.0b251001__py3-none-any.whl → 1.0.0b251016__py3-none-any.whl

agent_framework_copilotstudio/_acquire_token.py

@@ -16,6 +16,7 @@ DEFAULT_SCOPES = ["https://api.powerplatform.com/.default"]
 
 
 def acquire_token(
+    *,
     client_id: str,
     tenant_id: str,
     username: str | None = None,
@@ -27,7 +28,7 @@ def acquire_token(
     This function attempts to acquire a token silently first (using cached tokens),
     and falls back to interactive authentication if needed.
 
-    Args:
+    Keyword Args:
         client_id: The client ID of the application.
         tenant_id: The tenant ID for authentication.
         username: Optional username to filter accounts.

agent_framework_copilotstudio/_agent.py

@@ -31,18 +31,33 @@ class CopilotStudioSettings(AFBaseSettings):
     with the encoding 'utf-8'. If the settings are not found in the .env file, the settings
     are ignored; however, validation will fail alerting that the settings are missing.
 
-    Attributes:
-        environmentid: Environment ID of environment with the Copilot Studio App..
-            (Env var COPILOTSTUDIOAGENT__ENVIRONMENTID)
+    Keyword Args:
+        environmentid: Environment ID of environment with the Copilot Studio App.
+            Can be set via environment variable COPILOTSTUDIOAGENT__ENVIRONMENTID.
         schemaname: The agent identifier or schema name of the Copilot to use.
-            (Env var COPILOTSTUDIOAGENT__SCHEMANAME)
+            Can be set via environment variable COPILOTSTUDIOAGENT__SCHEMANAME.
         agentappid: The app ID of the App Registration used to login.
-            (Env var COPILOTSTUDIOAGENT__AGENTAPPID)
+            Can be set via environment variable COPILOTSTUDIOAGENT__AGENTAPPID.
         tenantid: The tenant ID of the App Registration used to login.
-            (Env var COPILOTSTUDIOAGENT__TENANTID)
-    Parameters:
+            Can be set via environment variable COPILOTSTUDIOAGENT__TENANTID.
         env_file_path: If provided, the .env settings are read from this file path location.
         env_file_encoding: The encoding of the .env file, defaults to 'utf-8'.
+
+    Examples:
+        .. code-block:: python
+
+            from agent_framework_copilotstudio import CopilotStudioSettings
+
+            # Using environment variables
+            # Set COPILOTSTUDIOAGENT__ENVIRONMENTID=env-123
+            # Set COPILOTSTUDIOAGENT__SCHEMANAME=my-agent
+            settings = CopilotStudioSettings()
+
+            # Or passing parameters directly
+            settings = CopilotStudioSettings(environmentid="env-123", schemaname="my-agent")
+
+            # Or loading from a .env file
+            settings = CopilotStudioSettings(env_file_path="path/to/.env")
     """
 
     env_prefix: ClassVar[str] = "COPILOTSTUDIOAGENT__"
@@ -87,6 +102,8 @@ class CopilotStudioAgent(BaseAgent):
                 a new client will be created using the other parameters.
             settings: Optional pre-configured ConnectionSettings. If not provided,
                 settings will be created from the other parameters.
+
+        Keyword Args:
             id: id of the CopilotAgent
             name: Name of the CopilotAgent
             description: Description of the CopilotAgent
@@ -209,6 +226,8 @@ class CopilotStudioAgent(BaseAgent):
 
         Args:
             messages: The message(s) to send to the agent.
+
+        Keyword Args:
             thread: The conversation thread associated with the message(s).
             kwargs: Additional keyword arguments.
 
@@ -248,6 +267,8 @@ class CopilotStudioAgent(BaseAgent):
 
         Args:
             messages: The message(s) to send to the agent.
+
+        Keyword Args:
             thread: The conversation thread associated with the message(s).
             kwargs: Additional keyword arguments.
 

{agent_framework_copilotstudio-1.0.0b251001.dist-info → agent_framework_copilotstudio-1.0.0b251016.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-framework-copilotstudio
-Version: 1.0.0b251001
+Version: 1.0.0b251016
 Summary: Copilot Studio integration for Microsoft Agent Framework.
 Author-email: Microsoft <af-support@microsoft.com>
 Requires-Python: >=3.10
@@ -27,7 +27,7 @@ Project-URL: source, https://github.com/microsoft/agent-framework/tree/main/pyth
 Please install this package via pip:
 
 ```bash
-pip install agent-framework-copilotstudio
+pip install agent-framework-copilotstudio --pre
 ```
 
 ## Copilot Studio Agent

agent_framework_copilotstudio-1.0.0b251016.dist-info/RECORD

@@ -0,0 +1,7 @@
+agent_framework_copilotstudio/__init__.py,sha256=n5OgoxpgvDY7Ttcgjcd0UG55d2fDmtWt6NmgvxYQOaU,391
+agent_framework_copilotstudio/_acquire_token.py,sha256=LzG4_U7jJyghDIndGJfV6tMq7LgfCpN2WaGXS8r83NQ,3675
+agent_framework_copilotstudio/_agent.py,sha256=WB_nR2Yvt86FAlHeQj3Zd-XKMgSisfOHbH6bwSxUh5o,14558
+agent_framework_copilotstudio-1.0.0b251016.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+agent_framework_copilotstudio-1.0.0b251016.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+agent_framework_copilotstudio-1.0.0b251016.dist-info/METADATA,sha256=CZk8S0dj4KTUwgXZ7PSXtgeitmo7aoVMFox6ooMLf3Y,4430
+agent_framework_copilotstudio-1.0.0b251016.dist-info/RECORD,,

agent_framework_copilotstudio-1.0.0b251001.dist-info/RECORD

@@ -1,7 +0,0 @@
-agent_framework_copilotstudio/__init__.py,sha256=n5OgoxpgvDY7Ttcgjcd0UG55d2fDmtWt6NmgvxYQOaU,391
-agent_framework_copilotstudio/_acquire_token.py,sha256=4g92MsaKbs7oPko7eXWFCYcph2HiufjoYAZJ9IqJb7A,3660
-agent_framework_copilotstudio/_agent.py,sha256=vtjGx0JH2FEzL5hsACk-Jd3nRfep65fQib8TBKDTGfo,13808
-agent_framework_copilotstudio-1.0.0b251001.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-agent_framework_copilotstudio-1.0.0b251001.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-agent_framework_copilotstudio-1.0.0b251001.dist-info/METADATA,sha256=tK0NES_3t-rjXNS-Vw2bsuu61EuqEDCfhq0pedUhGCE,4424
-agent_framework_copilotstudio-1.0.0b251001.dist-info/RECORD,,