microsoft-agents-hosting-core 0.6.0.dev4__tar.gz → 0.6.0.dev7__tar.gz

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 0.6.0.dev4
+Version: 0.6.0.dev7
 Summary: Core 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-activity==0.6.0.dev4
+Requires-Dist: microsoft-agents-activity==0.6.0.dev7
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: azure-core>=1.30.0

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents/hosting/core/activity_handler.py

@@ -3,6 +3,7 @@
 
 from __future__ import annotations
 from http import HTTPStatus
+from typing import Awaitable
 from pydantic import BaseModel
 
 from microsoft_agents.activity import TurnContextProtocol
@@ -24,9 +25,9 @@ class ActivityHandler(Agent):
     """
     Handles activities and should be subclassed.
 
-    .. remarks::
+    .. note::
         Derive from this class to handle particular activity types.
-        Yon can add pre and post processing of activities by calling the base class
+        You can add pre and post processing of activities by calling the base class
         in the derived class.
     """
 
@@ -34,15 +35,16 @@ class ActivityHandler(Agent):
         self, turn_context: TurnContextProtocol
     ):  # pylint: disable=arguments-differ
         """
-        Called by the adapter (for example, :class:`ChannelAdapter`) at runtime
+        Called by the adapter (for example, :class:`microsoft_agents.hosting.core.channel_adapter.ChannelAdapter`) at runtime
         in order to process an inbound :class:`microsoft_agents.activity.Activity`.
 
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
 
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             It calls other methods in this class based on the type of the activity to
             process, which allows a derived class to provide type-specific logic in a controlled way.
             In a derived class, override this method to add logic that applies to all activity types.
@@ -108,6 +110,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -121,6 +124,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -134,6 +138,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -145,17 +150,18 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_turn()` method receives a conversation update activity, it calls this
             method.
             Also
             - If the conversation update activity indicates that members other than the agent joined the conversation,
-            it calls the  :meth:`on_members_added_activity()` method.
+              it calls the :meth:`on_members_added_activity()` method.
             - If the conversation update activity indicates that members other than the agent left the conversation,
-            it calls the  :meth:`on_members_removed_activity()`  method.
+              it calls the :meth:`on_members_removed_activity()` method.
             - In a derived class, override this method to add logic that applies to all conversation update activities.
-            Add logic to apply before the member added or removed logic before the call to this base class method.
+              Add logic to apply before the member added or removed logic before the call to this base class method.
         """
         # TODO: confirm behavior of added and removed at the same time as C# doesn't support it
         if turn_context.activity.members_added:
@@ -175,13 +181,14 @@ class ActivityHandler(Agent):
         the conversation. You can add your agent's welcome logic.
 
         :param members_added: A list of all the members added to the conversation, as described by the
-        conversation update activity
+            conversation update activity
         :type members_added: list[:class:`microsoft_agents.activity.ChannelAccount`]
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_conversation_update_activity()` method receives a conversation
             update activity that indicates
             one or more users other than the agent are joining the conversation, it calls this method.
@@ -196,13 +203,14 @@ class ActivityHandler(Agent):
         the conversation.  You can add your agent's good-bye logic.
 
         :param members_removed: A list of all the members removed from the conversation, as described by the
-        conversation update activity
+            conversation update activity
         :type members_removed: list[:class:`microsoft_agents.activity.ChannelAccount`]
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_conversation_update_activity()` method receives a conversation
             update activity that indicates one or more users other than the agent are leaving the conversation,
             it calls this method.
@@ -219,8 +227,9 @@ class ActivityHandler(Agent):
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
 
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji) to a previously
             sent activity.
 
@@ -231,9 +240,9 @@ class ActivityHandler(Agent):
             method.
 
             - If the message reaction indicates that reactions were added to a message, it calls
-            :meth:`on_reaction_added()`.
+              :meth:`on_reactions_added()`.
             - If the message reaction indicates that reactions were removed from a message, it calls
-            :meth:`on_reaction_removed()`.
+              :meth:`on_reactions_removed()`.
 
             In a derived class, override this method to add logic that applies to all message reaction activities.
             Add logic to apply before the reactions added or removed logic before the call to the this base class
@@ -264,8 +273,9 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji)
             to a previously sent message on the conversation.
             Message reactions are supported by only a few channels.
@@ -290,8 +300,9 @@ class ActivityHandler(Agent):
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
 
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji)
             to a previously sent message on the conversation. Message reactions are supported by only a few channels.
             The activity that the message is in reaction to is identified by the activity's reply to Id property.
@@ -308,8 +319,9 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_turn()` method receives an event activity, it calls this method.
             If the activity name is `tokens/response`, it calls :meth:`on_token_response_event()`;
             otherwise, it calls :meth:`on_event()`.
@@ -338,8 +350,9 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_event()` method receives an event with an activity name of
             `tokens/response`, it calls this method. If your agent uses an `oauth_prompt`, forward the incoming
             activity to the current dialog.
@@ -352,11 +365,13 @@ class ActivityHandler(Agent):
         """
         Invoked when an event other than `tokens/response` is received when the base behavior of
         :meth:`on_event_activity()` is used.
+
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_event_activity()` is used method receives an event with an
             activity name other than `tokens/response`, it calls this method.
             This method could optionally be overridden if the agent is meant to handle miscellaneous events.
@@ -368,9 +383,11 @@ class ActivityHandler(Agent):
     ):
         """
         Invoked when a conversation end activity is received from the channel.
+
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -384,6 +401,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -397,6 +415,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         if turn_context.activity.action in ("add", "add-upgrade"):
             return await self.on_installation_update_add(turn_context)
@@ -414,6 +433,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -427,6 +447,7 @@ class ActivityHandler(Agent):
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         return
 
@@ -440,10 +461,10 @@ class ActivityHandler(Agent):
 
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
-
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
 
-        .. remarks::
+        .. note::
             When the :meth:`on_turn()` method receives an activity that is not a message,
             conversation update, message reaction, or event activity, it calls this method.
         """
@@ -494,8 +515,8 @@ class ActivityHandler(Agent):
 
         :param turn_context: The context object for this turn
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
-
         :returns: A task that represents the work queued to execute
+        :rtype: Awaitable[None]
         """
         raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)
 
@@ -512,7 +533,7 @@ class ActivityHandler(Agent):
         :type turn_context: :class:`microsoft_agents.activity.TurnContextProtocol`
         :param invoke_value: A string-typed object from the incoming activity's value.
         :type invoke_value: :class:`microsoft_agents.activity.AdaptiveCardInvokeValue`
-        :return: The HealthCheckResponse object
+        :returns: The HealthCheckResponse object
         :rtype: :class:`microsoft_agents.activity.AdaptiveCardInvokeResponse`
         """
         raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents/hosting/core/app/agent_application.py

@@ -236,7 +236,7 @@ class AgentApplication(Agent, Generic[StateT]):
         Routes are ordered by: is_agentic, is_invoke, rank (lower is higher priority), in that order.
 
         :param selector: A function that takes a TurnContext and returns a boolean indicating whether the route should be selected.
-        :type selector: :class:`microsoft_agents.hosting.core.app._type_defs.RouteSelector`
+        :type selector: Callable[[:class:`microsoft_agents.hosting.core.turn_context.TurnContext`], bool]
         :param handler: A function that takes a TurnContext and a TurnState and returns an Awaitable.
         :type handler: :class:`microsoft_agents.hosting.core.app._type_defs.RouteHandler`[StateT]
         :param is_invoke: Whether the route is for an invoke activity, defaults to False
@@ -245,7 +245,7 @@ class AgentApplication(Agent, Generic[StateT]):
             the selector will include a new check for `context.activity.is_agentic_request()`.
         :type is_agentic: bool, Optional
         :param rank: The rank of the route, defaults to RouteRank.DEFAULT
-        :type rank: :class:`microsoft_agents.hosting.core.app._routes.RouteRank`, Optional
+        :type rank: :class:`microsoft_agents.hosting.core.app._routes.route_rank.RouteRank`, Optional
         :param auth_handlers: A list of authentication handler IDs to use for this route, defaults to None
         :type auth_handlers: Optional[list[str]], Optional
         :raises ApplicationError: If the selector or handler are not valid.
@@ -272,19 +272,21 @@ class AgentApplication(Agent, Generic[StateT]):
         **kwargs,
     ) -> Callable[[RouteHandler[StateT]], RouteHandler[StateT]]:
         """
-        Registers a new activity event listener. This method can be used as either
-        a decorator or a method.
-
-        ```python
-        # Use this method as a decorator
-        @app.activity("event")
-        async def on_event(context: TurnContext, state: TurnState):
-            print("hello world!")
-            return True
-        ```
-
-        #### Args:
-        - `type`: The type of the activity
+        Register a new activity event listener as either a decorator or a method.
+
+        Example:
+            .. code-block:: python
+
+                @app.activity("event")
+                async def on_event(context: TurnContext, state: TurnState):
+                    print("hello world!")
+                    return True
+
+        :param activity_type: Activity type or collection of types that should trigger the handler.
+        :type activity_type: Union[str, microsoft_agents.activity.ActivityTypes, list[Union[str, microsoft_agents.activity.ActivityTypes]]]
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext):
@@ -307,18 +309,21 @@ class AgentApplication(Agent, Generic[StateT]):
         **kwargs,
     ) -> Callable[[RouteHandler[StateT]], RouteHandler[StateT]]:
         """
-        Registers a new message activity event listener. This method can be used as either
-        a decorator or a method.
-
-        ```python
-        # Use this method as a decorator
-        @app.message("hi")
-        async def on_hi_message(context: TurnContext, state: TurnState):
-            print("hello!")
-            return True
-
-        #### Args:
-        - `select`: a string or regex pattern
+        Register a new message activity event listener as either a decorator or a method.
+
+        Example:
+            .. code-block:: python
+
+                @app.message("hi")
+                async def on_hi_message(context: TurnContext, state: TurnState):
+                    print("hello!")
+                    return True
+
+        :param select: Literal text, compiled regex, or list of either used to match the incoming message.
+        :type select: Union[str, Pattern[str], list[Union[str, Pattern[str]]]]
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext):
@@ -349,20 +354,21 @@ class AgentApplication(Agent, Generic[StateT]):
         **kwargs,
     ) -> Callable[[RouteHandler[StateT]], RouteHandler[StateT]]:
         """
-        Registers a new message activity event listener. This method can be used as either
-        a decorator or a method.
+        Register a handler for conversation update activities as either a decorator or a method.
 
-        ```python
-        # Use this method as a decorator
-        @app.conversation_update("channelCreated")
-        async def on_channel_created(context: TurnContext, state: TurnState):
-            print("a new channel was created!")
-            return True
+        Example:
+            .. code-block:: python
 
-        ```
+                @app.conversation_update("channelCreated")
+                async def on_channel_created(context: TurnContext, state: TurnState):
+                    print("a new channel was created!")
+                    return True
 
-        #### Args:
-        - `type`: a string or regex pattern
+        :param type: Conversation update category that must match the incoming activity.
+        :type type: microsoft_agents.activity.ConversationUpdateTypes
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext):
@@ -402,19 +408,21 @@ class AgentApplication(Agent, Generic[StateT]):
         **kwargs,
     ) -> Callable[[RouteHandler[StateT]], RouteHandler[StateT]]:
         """
-        Registers a new message activity event listener. This method can be used as either
-        a decorator or a method.
-
-        ```python
-        # Use this method as a decorator
-        @app.message_reaction("reactionsAdded")
-        async def on_reactions_added(context: TurnContext, state: TurnState):
-            print("reactions was added!")
-            return True
-        ```
-
-        #### Args:
-        - `type`: a string or regex pattern
+        Register a handler for message reaction activities as either a decorator or a method.
+
+        Example:
+            .. code-block:: python
+
+                @app.message_reaction("reactionsAdded")
+                async def on_reactions_added(context: TurnContext, state: TurnState):
+                    print("reaction was added!")
+                    return True
+
+        :param type: Reaction category that must match the incoming activity.
+        :type type: microsoft_agents.activity.MessageReactionTypes
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext):
@@ -450,19 +458,21 @@ class AgentApplication(Agent, Generic[StateT]):
         **kwargs,
     ) -> Callable[[RouteHandler[StateT]], RouteHandler[StateT]]:
         """
-        Registers a new message activity event listener. This method can be used as either
-        a decorator or a method.
-
-        ```python
-        # Use this method as a decorator
-        @app.message_update("editMessage")
-        async def on_edit_message(context: TurnContext, state: TurnState):
-            print("message was edited!")
-            return True
-        ```
-
-        #### Args:
-        - `type`: a string or regex pattern
+        Register a handler for message update activities as either a decorator or a method.
+
+        Example:
+            .. code-block:: python
+
+                @app.message_update("editMessage")
+                async def on_edit_message(context: TurnContext, state: TurnState):
+                    print("message was edited!")
+                    return True
+
+        :param type: Message update category that must match the incoming activity.
+        :type type: microsoft_agents.activity.MessageUpdateTypes
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext):
@@ -510,15 +520,18 @@ class AgentApplication(Agent, Generic[StateT]):
         Callable[[TurnContext, StateT, str], Awaitable[None]],
     ]:
         """
-        Registers a handler to handoff conversations from one copilot to another.
-         ```python
-        # Use this method as a decorator
-        @app.handoff
-        async def on_handoff(
-            context: TurnContext, state: TurnState, continuation: str
-        ):
-            print(query)
-        ```
+        Register a handler to hand off conversations from one copilot to another.
+
+        Example:
+            .. code-block:: python
+
+                @app.handoff
+                async def on_handoff(context: TurnContext, state: TurnState, continuation: str):
+                    print(continuation)
+
+        :param auth_handlers: Optional list of authorization handler IDs for the route.
+        :type auth_handlers: Optional[list[str]]
+        :param kwargs: Additional route configuration passed to :meth:`add_route`.
         """
 
         def __selector(context: TurnContext) -> bool:
@@ -555,15 +568,18 @@ class AgentApplication(Agent, Generic[StateT]):
         self, func: Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]
     ) -> Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]:
         """
-        Registers a new event listener that will be executed when a user successfully signs in.
-
-        ```python
-        # Use this method as a decorator
-        @app.on_sign_in_success
-        async def sign_in_success(context: TurnContext, state: TurnState):
-            print("hello world!")
-            return True
-        ```
+        Register a callback that executes when a user successfully signs in.
+
+        Example:
+            .. code-block:: python
+
+                @app.on_sign_in_success
+                async def sign_in_success(context: TurnContext, state: TurnState, connection_id: str | None):
+                    print("sign-in succeeded")
+
+        :param func: Callable that handles the sign-in success event.
+        :type func: Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]
+        :raises ApplicationError: If authorization services are not configured.
         """
 
         if self._auth:
@@ -588,15 +604,18 @@ class AgentApplication(Agent, Generic[StateT]):
         self, func: Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]
     ) -> Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]:
         """
-        Registers a new event listener that will be executed when a user fails to sign in.
-
-        ```python
-        # Use this method as a decorator
-        @app.on_sign_in_failure
-        async def sign_in_failure(context: TurnContext, state: TurnState):
-            print("hello world!")
-            return True
-        ```
+        Register a callback that executes when a user fails to sign in.
+
+        Example:
+            .. code-block:: python
+
+                @app.on_sign_in_failure
+                async def sign_in_failure(context: TurnContext, state: TurnState, connection_id: str | None):
+                    print("sign-in failed")
+
+        :param func: Callable that handles the sign-in failure event.
+        :type func: Callable[[TurnContext, StateT, Optional[str]], Awaitable[None]]
+        :raises ApplicationError: If authorization services are not configured.
         """
 
         if self._auth:
@@ -621,15 +640,17 @@ class AgentApplication(Agent, Generic[StateT]):
         self, func: Callable[[TurnContext, Exception], Awaitable[None]]
     ) -> Callable[[TurnContext, Exception], Awaitable[None]]:
         """
-        Registers an error handler that will be called anytime
-        the app throws an Exception
-
-        ```python
-        # Use this method as a decorator
-        @app.error
-        async def on_error(context: TurnContext, err: Exception):
-            print(err.message)
-        ```
+        Register an error handler that is invoked whenever the application raises an exception.
+
+        Example:
+            .. code-block:: python
+
+                @app.error
+                async def on_error(context: TurnContext, err: Exception):
+                    print(err)
+
+        :param func: Callable executed when an uncaught exception occurs during a turn.
+        :type func: Callable[[TurnContext, Exception], Awaitable[None]]
         """
 
         logger.debug(f"Registering the error handler {func.__name__} ")

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents/hosting/core/app/typing_indicator.py

@@ -76,4 +76,3 @@ class TypingIndicator:
                 await asyncio.sleep(self._intervalSeconds)
         except asyncio.CancelledError:
             logger.debug("Typing indicator loop cancelled")
-            raise

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents/hosting/core/channel_adapter.py

@@ -42,8 +42,9 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :param context: The context object for the turn.
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param activities: The activities to send.
-        :type activities: list[Activity]
-        :return:
+        :type activities: list[microsoft_agents.activity.Activity]
+        :return: Channel responses produced by the adapter.
+        :rtype: list[microsoft_agents.activity.ResourceResponse]
         """
         raise NotImplementedError()
 
@@ -56,7 +57,8 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param activity: New replacement activity.
         :type activity: :class:`microsoft_agents.activity.Activity`
-        :return:
+        :return: None
+        :rtype: None
         """
         raise NotImplementedError()
 
@@ -71,7 +73,8 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param reference: Conversation reference for the activity to delete.
         :type reference: :class:`microsoft_agents.activity.ConversationReference`
-        :return:
+        :return: None
+        :rtype: None
         """
         raise NotImplementedError()
 
@@ -80,7 +83,9 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         Registers a middleware handler with the adapter.
 
         :param middleware: The middleware to register.
-        :return:
+        :type middleware: object
+        :return: The current adapter instance to support fluent calls.
+        :rtype: ChannelAdapter
         """
         self.middleware_set.use(middleware)
         return self
@@ -97,16 +102,14 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         to the user.
 
         :param agent_id: The application ID of the agent. This parameter is ignored in
-        single tenant the Adapters (Console, Test, etc) but is critical to the ChannelAdapter
-        which is multi-tenant aware.
+            single-tenant adapters (Console, Test, etc.) but is required for multi-tenant adapters.
+        :type agent_id: str
         :param reference: A reference to the conversation to continue.
         :type reference: :class:`microsoft_agents.activity.ConversationReference`
         :param callback: The method to call for the resulting agent turn.
         :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
-        :param claims_identity: A :class:`microsoft_agents.hosting.core.ClaimsIdentity` for the conversation.
-        :type claims_identity: :class:`microsoft_agents.hosting.core.ClaimsIdentity`
-        :param audience:A value signifying the recipient of the proactive message.
-        :type audience: str
+        :return: Result produced by the adapter pipeline.
+        :rtype: typing.Any
         """
         context = TurnContext(self, reference.get_continuation_activity())
         return await self.run_pipeline(context, callback)
@@ -123,7 +126,7 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         Most channels require a user to initiate a conversation with an agent before the agent can send activities
         to the user.
 
-        :param claims_identity: A :class:`microsoft_agents.hosting.core.ClaimsIdentity` for the conversation.
+        :param claims_identity: A :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity` for the conversation.
         :type claims_identity: :class:`microsoft_agents.hosting.core.authorization.ClaimsIdentity`
         :param continuation_activity: The activity to send.
         :type continuation_activity: :class:`microsoft_agents.activity.Activity`
@@ -131,6 +134,8 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
         :param audience: A value signifying the recipient of the proactive message.
         :type audience: str
+        :return: Result produced by the adapter pipeline.
+        :rtype: typing.Any
         """
         raise NotImplementedError()
 
@@ -154,16 +159,17 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :type service_url: str
         :param audience: A value signifying the recipient of the proactive message.
         :type audience: str
-        :param conversation_parameters: The information to use to create the conversation
+        :param conversation_parameters: The information to use to create the conversation.
         :type conversation_parameters: :class:`microsoft_agents.activity.ConversationParameters`
         :param callback: The method to call for the resulting agent turn.
         :type callback: Callable[[microsoft_agents.hosting.core.turn_context.TurnContext], Awaitable]
 
-        :raises: Exception - Not implemented or when the implementation fails.
+        :raises Exception: Not implemented or when the implementation fails.
 
         :return: A task representing the work queued to execute.
+        :rtype: typing.Any
 
-        .. remarks::
+        .. note::
             To start a conversation, your agent must know its account information and the user's
             account information on that channel.
             Most channels only support initiating a direct message (non-group) conversation.
@@ -225,7 +231,8 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param callback: A callback method to run at the end of the pipeline.
         :type callback: Callable[[TurnContext], Awaitable]
-        :return:
+        :return: Result produced by the middleware pipeline.
+        :rtype: typing.Any
         """
         if context is None:
             raise TypeError(context.__class__.__name__)

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents/hosting/core/channel_service_adapter.py

@@ -358,13 +358,13 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
         :return: A task that represents the work queued to execute.
         :rtype: Optional[:class:`microsoft_agents.activity.InvokeResponse`]
 
-        .. remarks::
+        .. note::
             This class processes an activity received by the agents web server. This includes any messages
             sent from a user and is the method that drives what's often referred to as the
             agent *reactive messaging* flow.
             Call this method to reactively send a message to a conversation.
-            If the task completes successfully, then an :class:`InvokeResponse` is returned;
-            otherwise, `null` is returned.
+            If the task completes successfully, then an :class:`microsoft_agents.activity.InvokeResponse` is returned;
+            otherwise, `None` is returned.
         """
         scopes: list[str] = None
         outgoing_audience: str = None
@@ -493,7 +493,14 @@ class ChannelServiceAdapter(ChannelAdapter, ABC):
 
         return context
 
-    def _process_turn_results(self, context: TurnContext) -> InvokeResponse:
+    def _process_turn_results(self, context: TurnContext) -> Optional[InvokeResponse]:
+        """Process the results of a turn and return the appropriate response.
+
+        :param context: The turn context
+        :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :return: The invoke response, if applicable
+        :rtype: Optional[:class:`microsoft_agents.activity.InvokeResponse`]
+        """
         # Handle ExpectedReplies scenarios where all activities have been
         # buffered and sent back at once in an invoke response.
         if context.activity.delivery_mode == DeliveryModes.expect_replies:

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents_hosting_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 0.6.0.dev4
+Version: 0.6.0.dev7
 Summary: Core 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-activity==0.6.0.dev4
+Requires-Dist: microsoft-agents-activity==0.6.0.dev7
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: azure-core>=1.30.0

{microsoft_agents_hosting_core-0.6.0.dev4 → microsoft_agents_hosting_core-0.6.0.dev7}/microsoft_agents_hosting_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-microsoft-agents-activity==0.6.0.dev4
+microsoft-agents-activity==0.6.0.dev7
 pyjwt>=2.10.1
 isodate>=0.6.1
 azure-core>=1.30.0