microsoft-agents-hosting-aiohttp 0.0.0__tar.gz

microsoft_agents_hosting_aiohttp-0.0.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-hosting-aiohttp
+Version: 0.0.0
+Summary: Integration library for Microsoft Agents with aiohttp
+Author: Microsoft Corporation
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Requires-Dist: microsoft-agents-hosting-core==0.0.0
+Requires-Dist: aiohttp>=3.11.11
+Dynamic: requires-dist

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/__init__.py

@@ -0,0 +1,25 @@
+from ._start_agent_process import start_agent_process
+from .agent_http_adapter import AgentHttpAdapter
+from .channel_service_route_table import channel_service_route_table
+from .cloud_adapter import CloudAdapter
+from .jwt_authorization_middleware import (
+    jwt_authorization_middleware,
+    jwt_authorization_decorator,
+)
+from .app.streaming import (
+    Citation,
+    CitationUtil,
+    StreamingResponse,
+)
+
+__all__ = [
+    "start_agent_process",
+    "AgentHttpAdapter",
+    "CloudAdapter",
+    "jwt_authorization_middleware",
+    "jwt_authorization_decorator",
+    "channel_service_route_table",
+    "Citation",
+    "CitationUtil",
+    "StreamingResponse",
+]

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/_start_agent_process.py

@@ -0,0 +1,26 @@
+from typing import Optional
+from aiohttp.web import Request, Response
+from microsoft.agents.hosting.core.app import AgentApplication
+from .cloud_adapter import CloudAdapter
+
+
+async def start_agent_process(
+    request: Request,
+    agent_application: AgentApplication,
+    adapter: CloudAdapter,
+) -> Optional[Response]:
+    """Starts the agent host with the provided adapter and agent application.
+    Args:
+        adapter (CloudAdapter): The adapter to use for the agent host.
+        agent_application (AgentApplication): The agent application to run.
+    """
+    if not adapter:
+        raise TypeError("start_agent_process: adapter can't be None")
+    if not agent_application:
+        raise TypeError("start_agent_process: agent_application can't be None")
+
+    # Start the agent application with the provided adapter
+    return await adapter.process(
+        request,
+        agent_application,
+    )

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/agent_http_adapter.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from abc import abstractmethod
+from typing import Optional, Protocol
+
+from aiohttp.web import (
+    Request,
+    Response,
+)
+
+from microsoft.agents.hosting.core import Agent
+
+
+class AgentHttpAdapter(Protocol):
+    @abstractmethod
+    async def process(self, request: Request, agent: Agent) -> Optional[Response]:
+        raise NotImplementedError()

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/app/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .streaming import (
+    Citation,
+    CitationUtil,
+    StreamingResponse,
+)
+
+__all__ = [
+    "Citation",
+    "CitationUtil",
+    "StreamingResponse",
+]

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/app/streaming/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .citation import Citation
+from .citation_util import CitationUtil
+from .streaming_response import StreamingResponse
+
+__all__ = [
+    "Citation",
+    "CitationUtil",
+    "StreamingResponse",
+]

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/app/streaming/citation.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Optional
+from dataclasses import dataclass
+
+
+@dataclass
+class Citation:
+    """Citations returned by the model."""
+
+    content: str
+    """The content of the citation."""
+
+    title: Optional[str] = None
+    """The title of the citation."""
+
+    url: Optional[str] = None
+    """The URL of the citation."""
+
+    filepath: Optional[str] = None
+    """The filepath of the document."""

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/app/streaming/citation_util.py

@@ -0,0 +1,85 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import re
+from typing import List, Optional
+
+from microsoft.agents.activity import ClientCitation
+
+
+class CitationUtil:
+    """Utility functions for manipulating text and citations."""
+
+    @staticmethod
+    def snippet(text: str, max_length: int) -> str:
+        """
+        Clips the text to a maximum length in case it exceeds the limit.
+
+        Args:
+            text: The text to clip.
+            max_length: The maximum length of the text to return, cutting off the last whole word.
+
+        Returns:
+            The modified text
+        """
+        if len(text) <= max_length:
+            return text
+
+        snippet = text[:max_length]
+        snippet = snippet[: min(len(snippet), snippet.rfind(" "))]
+        snippet += "..."
+        return snippet
+
+    @staticmethod
+    def format_citations_response(text: str) -> str:
+        """
+        Convert citation tags `[doc(s)n]` to `[n]` where n is a number.
+
+        Args:
+            text: The text to format.
+
+        Returns:
+            The formatted text.
+        """
+        return re.sub(r"\[docs?(\d+)\]", r"[\1]", text, flags=re.IGNORECASE)
+
+    @staticmethod
+    def get_used_citations(
+        text: str, citations: List[ClientCitation]
+    ) -> Optional[List[ClientCitation]]:
+        """
+        Get the citations used in the text. This will remove any citations that are
+        included in the citations array from the response but not referenced in the text.
+
+        Args:
+            text: The text to search for citation references, i.e. [1], [2], etc.
+            citations: The list of citations to search for.
+
+        Returns:
+            The list of citations used in the text.
+        """
+        regex = re.compile(r"\[(\d+)\]", re.IGNORECASE)
+        matches = regex.findall(text)
+
+        if not matches:
+            return None
+
+        # Remove duplicates
+        filtered_matches = set(matches)
+
+        # Add citations
+        used_citations = []
+        for match in filtered_matches:
+            citation_ref = f"[{match}]"
+            found = next(
+                (
+                    citation
+                    for citation in citations
+                    if f"[{citation.position}]" == citation_ref
+                ),
+                None,
+            )
+            if found:
+                used_citations.append(found)
+
+        return used_citations if used_citations else None

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/app/streaming/streaming_response.py

@@ -0,0 +1,412 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import asyncio
+import logging
+from typing import List, Optional, Callable, Literal, TYPE_CHECKING
+from dataclasses import dataclass
+
+from microsoft.agents.activity import (
+    Activity,
+    Entity,
+    Attachment,
+    Channels,
+    ClientCitation,
+    DeliveryModes,
+    SensitivityUsageInfo,
+    add_ai_to_activity,
+)
+
+if TYPE_CHECKING:
+    from microsoft.agents.hosting.core.turn_context import TurnContext
+
+from .citation import Citation
+from .citation_util import CitationUtil
+
+logger = logging.getLogger(__name__)
+
+
+class StreamingResponse:
+    """
+    A helper class for streaming responses to the client.
+
+    This class is used to send a series of updates to the client in a single response.
+    The expected sequence of calls is:
+
+    `queue_informative_update()`, `queue_text_chunk()`, `queue_text_chunk()`, ..., `end_stream()`.
+
+    Once `end_stream()` is called, the stream is considered ended and no further updates can be sent.
+    """
+
+    def __init__(self, context: "TurnContext"):
+        """
+        Creates a new StreamingResponse instance.
+
+        Args:
+            context: Context for the current turn of conversation with the user.
+        """
+        self._context = context
+        self._sequence_number = 1
+        self._stream_id: Optional[str] = None
+        self._message = ""
+        self._attachments: Optional[List[Attachment]] = None
+        self._ended = False
+        self._cancelled = False
+
+        # Queue for outgoing activities
+        self._queue: List[Callable[[], Activity]] = []
+        self._queue_sync: Optional[asyncio.Task] = None
+        self._chunk_queued = False
+
+        # Powered by AI feature flags
+        self._enable_feedback_loop = False
+        self._feedback_loop_type: Optional[Literal["default", "custom"]] = None
+        self._enable_generated_by_ai_label = False
+        self._citations: Optional[List[ClientCitation]] = []
+        self._sensitivity_label: Optional[SensitivityUsageInfo] = None
+
+        # Channel information
+        self._is_streaming_channel: bool = False
+        self._channel_id: Channels = None
+        self._interval: float = 0.1  # Default interval for sending updates
+        self._set_defaults(context)
+
+    @property
+    def stream_id(self) -> Optional[str]:
+        """
+        Gets the stream ID of the current response.
+        Assigned after the initial update is sent.
+        """
+        return self._stream_id
+
+    @property
+    def citations(self) -> Optional[List[ClientCitation]]:
+        """Gets the citations of the current response."""
+        return self._citations
+
+    @property
+    def updates_sent(self) -> int:
+        """Gets the number of updates sent for the stream."""
+        return self._sequence_number - 1
+
+    def queue_informative_update(self, text: str) -> None:
+        """
+        Queues an informative update to be sent to the client.
+
+        Args:
+            text: Text of the update to send.
+        """
+        if not self._is_streaming_channel:
+            return
+
+        if self._ended:
+            raise RuntimeError("The stream has already ended.")
+
+        # Queue a typing activity
+        def create_activity():
+            activity = Activity(
+                type="typing",
+                text=text,
+                entities=[
+                    Entity(
+                        type="streaminfo",
+                        stream_type="informative",
+                        stream_sequence=self._sequence_number,
+                    )
+                ],
+            )
+            self._sequence_number += 1
+            return activity
+
+        self._queue_activity(create_activity)
+
+    def queue_text_chunk(
+        self, text: str, citations: Optional[List[Citation]] = None
+    ) -> None:
+        """
+        Queues a chunk of partial message text to be sent to the client.
+
+        The text will be sent as quickly as possible to the client.
+        Chunks may be combined before delivery to the client.
+
+        Args:
+            text: Partial text of the message to send.
+            citations: Citations to be included in the message.
+        """
+        if self._cancelled:
+            return
+        if self._ended:
+            raise RuntimeError("The stream has already ended.")
+
+        # Update full message text
+        self._message += text
+
+        # If there are citations, modify the content so that the sources are numbers instead of [doc1], [doc2], etc.
+        self._message = CitationUtil.format_citations_response(self._message)
+
+        # Queue the next chunk
+        self._queue_next_chunk()
+
+    async def end_stream(self) -> None:
+        """
+        Ends the stream by sending the final message to the client.
+        """
+        if self._ended:
+            raise RuntimeError("The stream has already ended.")
+
+        # Queue final message
+        self._ended = True
+        self._queue_next_chunk()
+
+        # Wait for the queue to drain
+        await self.wait_for_queue()
+
+    def set_attachments(self, attachments: List[Attachment]) -> None:
+        """
+        Sets the attachments to attach to the final chunk.
+
+        Args:
+            attachments: List of attachments.
+        """
+        self._attachments = attachments
+
+    def set_sensitivity_label(self, sensitivity_label: SensitivityUsageInfo) -> None:
+        """
+        Sets the sensitivity label to attach to the final chunk.
+
+        Args:
+            sensitivity_label: The sensitivity label.
+        """
+        self._sensitivity_label = sensitivity_label
+
+    def set_citations(self, citations: List[Citation]) -> None:
+        """
+        Sets the citations for the full message.
+
+        Args:
+            citations: Citations to be included in the message.
+        """
+        if citations:
+            if not self._citations:
+                self._citations = []
+
+            curr_pos = len(self._citations)
+
+            for citation in citations:
+                client_citation = ClientCitation(
+                    type="Claim",
+                    position=curr_pos + 1,
+                    appearance={
+                        "type": "DigitalDocument",
+                        "name": citation.title or f"Document #{curr_pos + 1}",
+                        "abstract": CitationUtil.snippet(citation.content, 477),
+                    },
+                )
+                curr_pos += 1
+                self._citations.append(client_citation)
+
+    def set_feedback_loop(self, enable_feedback_loop: bool) -> None:
+        """
+        Sets the Feedback Loop in Teams that allows a user to
+        give thumbs up or down to a response.
+        Default is False.
+
+        Args:
+            enable_feedback_loop: If true, the feedback loop is enabled.
+        """
+        self._enable_feedback_loop = enable_feedback_loop
+
+    def set_feedback_loop_type(
+        self, feedback_loop_type: Literal["default", "custom"]
+    ) -> None:
+        """
+        Sets the type of UI to use for the feedback loop.
+
+        Args:
+            feedback_loop_type: The type of the feedback loop.
+        """
+        self._feedback_loop_type = feedback_loop_type
+
+    def set_generated_by_ai_label(self, enable_generated_by_ai_label: bool) -> None:
+        """
+        Sets the Generated by AI label in Teams.
+        Default is False.
+
+        Args:
+            enable_generated_by_ai_label: If true, the label is added.
+        """
+        self._enable_generated_by_ai_label = enable_generated_by_ai_label
+
+    def get_message(self) -> str:
+        """
+        Returns the most recently streamed message.
+        """
+        return self._message
+
+    async def wait_for_queue(self) -> None:
+        """
+        Waits for the outgoing activity queue to be empty.
+        """
+        if self._queue_sync:
+            await self._queue_sync
+
+    def _set_defaults(self, context: "TurnContext"):
+        if context.activity.channel_id == Channels.ms_teams:
+            self._is_streaming_channel = True
+            self._interval = 1.0
+        elif context.activity.channel_id == Channels.direct_line:
+            self._is_streaming_channel = True
+            self._interval = 0.5
+        elif context.activity.delivery_mode == DeliveryModes.stream:
+            self._is_streaming_channel = True
+            self._interval = 0.1
+
+        self._channel_id = context.activity.channel_id
+
+    def _queue_next_chunk(self) -> None:
+        """
+        Queues the next chunk of text to be sent to the client.
+        """
+        # Are we already waiting to send a chunk?
+        if self._chunk_queued:
+            return
+
+        # Queue a chunk of text to be sent
+        self._chunk_queued = True
+
+        def create_activity():
+            self._chunk_queued = False
+            if self._ended:
+                # Send final message
+                activity = Activity(
+                    type="message",
+                    text=self._message or "end stream response",
+                    attachments=self._attachments or [],
+                    entities=[
+                        Entity(
+                            type="streaminfo",
+                            stream_type="final",
+                            stream_sequence=self._sequence_number,
+                        )
+                    ],
+                )
+            elif self._is_streaming_channel:
+                # Send typing activity
+                activity = Activity(
+                    type="typing",
+                    text=self._message,
+                    entities=[
+                        Entity(
+                            type="streaminfo",
+                            stream_type="streaming",
+                            stream_sequence=self._sequence_number,
+                        )
+                    ],
+                )
+            else:
+                return
+            self._sequence_number += 1
+            return activity
+
+        self._queue_activity(create_activity)
+
+    def _queue_activity(self, factory: Callable[[], Activity]) -> None:
+        """
+        Queues an activity to be sent to the client.
+        """
+        self._queue.append(factory)
+
+        # If there's no sync in progress, start one
+        if not self._queue_sync:
+            self._queue_sync = asyncio.create_task(self._drain_queue())
+
+    async def _drain_queue(self) -> None:
+        """
+        Sends any queued activities to the client until the queue is empty.
+        """
+        try:
+            logger.debug(f"Draining queue with {len(self._queue)} activities.")
+            while self._queue:
+                factory = self._queue.pop(0)
+                activity = factory()
+                if activity:
+                    await self._send_activity(activity)
+        except Exception as err:
+            if (
+                "403" in str(err)
+                and self._context.activity.channel_id == Channels.ms_teams
+            ):
+                logger.warning("Teams channel stopped the stream.")
+                self._cancelled = True
+            else:
+                logger.error(
+                    f"Error occurred when sending activity while streaming: {err}"
+                )
+                raise
+        finally:
+            self._queue_sync = None
+
+    async def _send_activity(self, activity: Activity) -> None:
+        """
+        Sends an activity to the client and saves the stream ID returned.
+
+        Args:
+            activity: The activity to send.
+        """
+
+        streaminfo_entity = None
+
+        if not activity.entities:
+            streaminfo_entity = Entity(type="streaminfo")
+            activity.entities = [streaminfo_entity]
+        else:
+            for entity in activity.entities:
+                if hasattr(entity, "type") and entity.type == "streaminfo":
+                    streaminfo_entity = entity
+                    break
+
+            if not streaminfo_entity:
+                # If no streaminfo entity exists, create one
+                streaminfo_entity = Entity(type="streaminfo")
+                activity.entities.append(streaminfo_entity)
+
+        # Set activity ID to the assigned stream ID
+        if self._stream_id:
+            activity.id = self._stream_id
+            streaminfo_entity.stream_id = self._stream_id
+
+        if self._citations and len(self._citations) > 0 and not self._ended:
+            # Filter out the citations unused in content.
+            curr_citations = CitationUtil.get_used_citations(
+                self._message, self._citations
+            )
+            if curr_citations:
+                activity.entities.append(
+                    Entity(
+                        type="https://schema.org/Message",
+                        schema_type="Message",
+                        context="https://schema.org",
+                        id="",
+                        citation=curr_citations,
+                    )
+                )
+
+        # Add in Powered by AI feature flags
+        if self._ended:
+            if self._enable_feedback_loop and self._feedback_loop_type:
+                # Add feedback loop to streaminfo entity
+                streaminfo_entity.feedback_loop = {"type": self._feedback_loop_type}
+            else:
+                # Add feedback loop enabled to streaminfo entity
+                streaminfo_entity.feedback_loop_enabled = self._enable_feedback_loop
+        # Add in Generated by AI
+        if self._enable_generated_by_ai_label:
+            add_ai_to_activity(activity, self._citations, self._sensitivity_label)
+
+        # Send activity
+        response = await self._context.send_activity(activity)
+        await asyncio.sleep(self._interval)
+
+        # Save assigned stream ID
+        if not self._stream_id and response:
+            self._stream_id = response.id

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/channel_service_route_table.py

@@ -0,0 +1,194 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+import json
+from typing import List, Union, Type
+
+from aiohttp.web import RouteTableDef, Request, Response
+
+from microsoft.agents.activity import (
+    AgentsModel,
+    Activity,
+    AttachmentData,
+    ConversationParameters,
+    Transcript,
+)
+from microsoft.agents.hosting.core import ChannelApiHandlerProtocol
+
+
+async def deserialize_from_body(
+    request: Request, target_model: Type[AgentsModel]
+) -> Activity:
+    if "application/json" in request.headers["Content-Type"]:
+        body = await request.json()
+    else:
+        return Response(status=415)
+
+    return target_model.model_validate(body)
+
+
+def get_serialized_response(
+    model_or_list: Union[AgentsModel, List[AgentsModel]],
+) -> Response:
+    if isinstance(model_or_list, AgentsModel):
+        json_obj = model_or_list.model_dump(
+            mode="json", exclude_unset=True, by_alias=True
+        )
+    else:
+        json_obj = [
+            model.model_dump(mode="json", exclude_unset=True, by_alias=True)
+            for model in model_or_list
+        ]
+
+    return Response(body=json.dumps(json_obj), content_type="application/json")
+
+
+def channel_service_route_table(
+    handler: ChannelApiHandlerProtocol, base_url: str = ""
+) -> RouteTableDef:
+    # pylint: disable=unused-variable
+    routes = RouteTableDef()
+
+    @routes.post(base_url + "/v3/conversations/{conversation_id}/activities")
+    async def send_to_conversation(request: Request):
+        activity = await deserialize_from_body(request, Activity)
+        result = await handler.on_send_to_conversation(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            activity,
+        )
+
+        return get_serialized_response(result)
+
+    @routes.post(
+        base_url + "/v3/conversations/{conversation_id}/activities/{activity_id}"
+    )
+    async def reply_to_activity(request: Request):
+        activity = await deserialize_from_body(request, Activity)
+        result = await handler.on_reply_to_activity(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            request.match_info["activity_id"],
+            activity,
+        )
+
+        return get_serialized_response(result)
+
+    @routes.put(
+        base_url + "/v3/conversations/{conversation_id}/activities/{activity_id}"
+    )
+    async def update_activity(request: Request):
+        activity = await deserialize_from_body(request, Activity)
+        result = await handler.on_update_activity(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            request.match_info["activity_id"],
+            activity,
+        )
+
+        return get_serialized_response(result)
+
+    @routes.delete(
+        base_url + "/v3/conversations/{conversation_id}/activities/{activity_id}"
+    )
+    async def delete_activity(request: Request):
+        await handler.on_delete_activity(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            request.match_info["activity_id"],
+        )
+
+        return Response()
+
+    @routes.get(
+        base_url
+        + "/v3/conversations/{conversation_id}/activities/{activity_id}/members"
+    )
+    async def get_activity_members(request: Request):
+        result = await handler.on_get_activity_members(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            request.match_info["activity_id"],
+        )
+
+        return get_serialized_response(result)
+
+    @routes.post(base_url + "/")
+    async def create_conversation(request: Request):
+        conversation_parameters = deserialize_from_body(request, ConversationParameters)
+        result = await handler.on_create_conversation(
+            request.get("claims_identity"), conversation_parameters
+        )
+
+        return get_serialized_response(result)
+
+    @routes.get(base_url + "/")
+    async def get_conversation(request: Request):
+        # TODO: continuation token? conversation_id?
+        result = await handler.on_get_conversations(
+            request.get("claims_identity"), None
+        )
+
+        return get_serialized_response(result)
+
+    @routes.get(base_url + "/v3/conversations/{conversation_id}/members")
+    async def get_conversation_members(request: Request):
+        result = await handler.on_get_conversation_members(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+        )
+
+        return get_serialized_response(result)
+
+    @routes.get(base_url + "/v3/conversations/{conversation_id}/members/{member_id}")
+    async def get_conversation_member(request: Request):
+        result = await handler.on_get_conversation_member(
+            request.get("claims_identity"),
+            request.match_info["member_id"],
+            request.match_info["conversation_id"],
+        )
+
+        return get_serialized_response(result)
+
+    @routes.get(base_url + "/v3/conversations/{conversation_id}/pagedmembers")
+    async def get_conversation_paged_members(request: Request):
+        # TODO: continuation token? page size?
+        result = await handler.on_get_conversation_paged_members(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+        )
+
+        return get_serialized_response(result)
+
+    @routes.delete(base_url + "/v3/conversations/{conversation_id}/members/{member_id}")
+    async def delete_conversation_member(request: Request):
+        result = await handler.on_delete_conversation_member(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            request.match_info["member_id"],
+        )
+
+        return get_serialized_response(result)
+
+    @routes.post(base_url + "/v3/conversations/{conversation_id}/activities/history")
+    async def send_conversation_history(request: Request):
+        transcript = deserialize_from_body(request, Transcript)
+        result = await handler.on_send_conversation_history(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            transcript,
+        )
+
+        return get_serialized_response(result)
+
+    @routes.post(base_url + "/v3/conversations/{conversation_id}/attachments")
+    async def upload_attachment(request: Request):
+        attachment_data = deserialize_from_body(request, AttachmentData)
+        result = await handler.on_upload_attachment(
+            request.get("claims_identity"),
+            request.match_info["conversation_id"],
+            attachment_data,
+        )
+
+        return get_serialized_response(result)
+
+    return routes

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/cloud_adapter.py

@@ -0,0 +1,114 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+from traceback import format_exc
+from typing import Optional
+
+from aiohttp.web import (
+    Request,
+    Response,
+    json_response,
+    HTTPBadRequest,
+    HTTPMethodNotAllowed,
+    HTTPUnauthorized,
+    HTTPUnsupportedMediaType,
+)
+from microsoft.agents.hosting.core.authorization import (
+    ClaimsIdentity,
+    Connections,
+)
+from microsoft.agents.activity import (
+    Activity,
+    DeliveryModes,
+)
+from microsoft.agents.hosting.core import (
+    Agent,
+    ChannelServiceAdapter,
+    ChannelServiceClientFactoryBase,
+    MessageFactory,
+    RestChannelServiceClientFactory,
+    TurnContext,
+)
+
+from .agent_http_adapter import AgentHttpAdapter
+
+
+class CloudAdapter(ChannelServiceAdapter, AgentHttpAdapter):
+    def __init__(
+        self,
+        *,
+        connection_manager: Connections,
+        channel_service_client_factory: ChannelServiceClientFactoryBase = None,
+    ):
+        """
+        Initializes a new instance of the CloudAdapter class.
+
+        :param channel_service_client_factory: The factory to use to create the channel service client.
+        """
+
+        async def on_turn_error(context: TurnContext, error: Exception):
+            error_message = f"Exception caught : {error}"
+            print(format_exc())
+
+            await context.send_activity(MessageFactory.text(error_message))
+
+            # Send a trace activity
+            await context.send_trace_activity(
+                "OnTurnError Trace",
+                error_message,
+                "https://www.botframework.com/schemas/error",
+                "TurnError",
+            )
+
+        self.on_turn_error = on_turn_error
+
+        channel_service_client_factory = (
+            channel_service_client_factory
+            or RestChannelServiceClientFactory(connection_manager)
+        )
+
+        super().__init__(channel_service_client_factory)
+
+    async def process(self, request: Request, agent: Agent) -> Optional[Response]:
+        if not request:
+            raise TypeError("CloudAdapter.process: request can't be None")
+        if not agent:
+            raise TypeError("CloudAdapter.process: agent can't be None")
+
+        if request.method == "POST":
+            # Deserialize the incoming Activity
+            if "application/json" in request.headers["Content-Type"]:
+                body = await request.json()
+            else:
+                raise HTTPUnsupportedMediaType()
+
+            activity: Activity = Activity.model_validate(body)
+            claims_identity: ClaimsIdentity = request.get("claims_identity")
+
+            # A POST request must contain an Activity
+            if (
+                not activity.type
+                or not activity.conversation
+                or not activity.conversation.id
+            ):
+                raise HTTPBadRequest
+
+            try:
+                # Process the inbound activity with the agent
+                invoke_response = await self.process_activity(
+                    claims_identity, activity, agent.on_turn
+                )
+
+                if (
+                    activity.type == "invoke"
+                    or activity.delivery_mode == DeliveryModes.expect_replies
+                ):
+                    # Invoke and ExpectReplies cannot be performed async, the response must be written before the calling thread is released.
+                    return json_response(
+                        data=invoke_response.body, status=invoke_response.status
+                    )
+
+                return Response(status=202)
+            except PermissionError:
+                raise HTTPUnauthorized
+        else:
+            raise HTTPMethodNotAllowed

microsoft_agents_hosting_aiohttp-0.0.0/microsoft/agents/hosting/aiohttp/jwt_authorization_middleware.py

@@ -0,0 +1,62 @@
+import functools
+from aiohttp.web import Request, middleware, json_response
+
+from microsoft.agents.hosting.core.authorization import (
+    AgentAuthConfiguration,
+    JwtTokenValidator,
+)
+
+
+@middleware
+async def jwt_authorization_middleware(request: Request, handler):
+    auth_config: AgentAuthConfiguration = request.app["agent_configuration"]
+    token_validator = JwtTokenValidator(auth_config)
+    auth_header = request.headers.get("Authorization")
+    if auth_header:
+        # Extract the token from the Authorization header
+        token = auth_header.split(" ")[1]
+        try:
+            claims = token_validator.validate_token(token)
+            request["claims_identity"] = claims
+        except ValueError as e:
+            print(f"JWT validation error: {e}")
+            return json_response({"error": str(e)}, status=401)
+    else:
+        if not auth_config.CLIENT_ID:
+            # TODO: Refine anonymous strategy
+            request["claims_identity"] = token_validator.get_anonymous_claims()
+        else:
+            return json_response(
+                {"error": "Authorization header not found"}, status=401
+            )
+
+    return await handler(request)
+
+
+def jwt_authorization_decorator(func):
+    @functools.wraps(func)
+    async def wrapper(request):
+        auth_config: AgentAuthConfiguration = request.app["agent_configuration"]
+        token_validator = JwtTokenValidator(auth_config)
+        auth_header = request.headers.get("Authorization")
+        if auth_header:
+            # Extract the token from the Authorization header
+            token = auth_header.split(" ")[1]
+            try:
+                claims = token_validator.validate_token(token)
+                request["claims_identity"] = claims
+            except ValueError as e:
+                print(f"JWT validation error: {e}")
+                return json_response({"error": str(e)}, status=401)
+        else:
+            if not auth_config.CLIENT_ID:
+                # TODO: Refine anonymous strategy
+                request["claims_identity"] = token_validator.get_anonymous_claims()
+            else:
+                return json_response(
+                    {"error": "Authorization header not found"}, status=401
+                )
+
+        return await func(request)
+
+    return wrapper

microsoft_agents_hosting_aiohttp-0.0.0/microsoft_agents_hosting_aiohttp.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-hosting-aiohttp
+Version: 0.0.0
+Summary: Integration library for Microsoft Agents with aiohttp
+Author: Microsoft Corporation
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Requires-Dist: microsoft-agents-hosting-core==0.0.0
+Requires-Dist: aiohttp>=3.11.11
+Dynamic: requires-dist

microsoft_agents_hosting_aiohttp-0.0.0/microsoft_agents_hosting_aiohttp.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+pyproject.toml
+setup.py
+microsoft/agents/hosting/aiohttp/__init__.py
+microsoft/agents/hosting/aiohttp/_start_agent_process.py
+microsoft/agents/hosting/aiohttp/agent_http_adapter.py
+microsoft/agents/hosting/aiohttp/channel_service_route_table.py
+microsoft/agents/hosting/aiohttp/cloud_adapter.py
+microsoft/agents/hosting/aiohttp/jwt_authorization_middleware.py
+microsoft/agents/hosting/aiohttp/app/__init__.py
+microsoft/agents/hosting/aiohttp/app/streaming/__init__.py
+microsoft/agents/hosting/aiohttp/app/streaming/citation.py
+microsoft/agents/hosting/aiohttp/app/streaming/citation_util.py
+microsoft/agents/hosting/aiohttp/app/streaming/streaming_response.py
+microsoft_agents_hosting_aiohttp.egg-info/PKG-INFO
+microsoft_agents_hosting_aiohttp.egg-info/SOURCES.txt
+microsoft_agents_hosting_aiohttp.egg-info/dependency_links.txt
+microsoft_agents_hosting_aiohttp.egg-info/requires.txt
+microsoft_agents_hosting_aiohttp.egg-info/top_level.txt

microsoft_agents_hosting_aiohttp-0.0.0/microsoft_agents_hosting_aiohttp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

microsoft_agents_hosting_aiohttp-0.0.0/microsoft_agents_hosting_aiohttp.egg-info/requires.txt

@@ -0,0 +1,2 @@
+microsoft-agents-hosting-core==0.0.0
+aiohttp>=3.11.11

microsoft_agents_hosting_aiohttp-0.0.0/microsoft_agents_hosting_aiohttp.egg-info/top_level.txt

@@ -0,0 +1 @@
+microsoft

microsoft_agents_hosting_aiohttp-0.0.0/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "microsoft-agents-hosting-aiohttp"
+dynamic = ["version", "dependencies"]
+description = "Integration library for Microsoft Agents with aiohttp"
+authors = [{name = "Microsoft Corporation"}]
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/microsoft/Agents"

microsoft_agents_hosting_aiohttp-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

microsoft_agents_hosting_aiohttp-0.0.0/setup.py

@@ -0,0 +1,12 @@
+from os import environ
+from setuptools import setup
+
+package_version = environ.get("PackageVersion", "0.0.0")
+
+setup(
+    version=package_version,
+    install_requires=[
+        f"microsoft-agents-hosting-core=={package_version}",
+        "aiohttp>=3.11.11",
+    ],
+)