microsoft-agents-hosting-core 0.7.0.dev0__py3-none-any.whl → 0.7.0.dev1__py3-none-any.whl

microsoft_agents/hosting/core/__init__.py

@@ -10,6 +10,15 @@ from .middleware_set import Middleware
 from .rest_channel_service_client_factory import RestChannelServiceClientFactory
 from .turn_context import TurnContext
 
+# HTTP abstractions
+from .http import (
+    HttpRequestProtocol,
+    HttpResponse,
+    HttpResponseFactory,
+    HttpAdapterBase,
+    ChannelServiceRoutes,
+)
+
 # Application Style
 from .app._type_defs import RouteHandler, RouteSelector, StateT
 from .app.agent_application import AgentApplication
@@ -20,6 +29,13 @@ from .app.query import Query
 from .app._routes import _Route, _RouteList, RouteRank
 from .app.typing_indicator import TypingIndicator
 
+# App Streaming
+from .app.streaming import (
+    Citation,
+    CitationUtil,
+    StreamingResponse,
+)
+
 # App Auth
 from .app.oauth import (
     Authorization,
@@ -99,6 +115,11 @@ __all__ = [
     "Middleware",
     "RestChannelServiceClientFactory",
     "TurnContext",
+    "HttpRequestProtocol",
+    "HttpResponse",
+    "HttpResponseFactory",
+    "HttpAdapterBase",
+    "ChannelServiceRoutes",
     "AgentApplication",
     "ApplicationError",
     "ApplicationOptions",
@@ -108,6 +129,9 @@ __all__ = [
     "Route",
     "RouteHandler",
     "TypingIndicator",
+    "Citation",
+    "CitationUtil",
+    "StreamingResponse",
     "ConversationState",
     "state",
     "State",

microsoft_agents/hosting/core/app/streaming/__init__.py

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

microsoft_agents/hosting/core/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/core/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/core/app/streaming/streaming_response.py

@@ -0,0 +1,411 @@
+# 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 microsoft_agents.activity import (
+    Activity,
+    Entity,
+    Attachment,
+    Channels,
+    ClientCitation,
+    DeliveryModes,
+    SensitivityUsageInfo,
+)
+
+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 Channels.ms_teams == context.activity.channel_id.channel:
+            self._is_streaming_channel = True
+            self._interval = 1.0
+        elif Channels.direct_line == context.activity.channel_id.channel:
+            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_id=self._stream_id,
+                            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:
+            activity.add_ai_metadata(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/core/http/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""HTTP abstractions for framework-agnostic adapter implementations."""
+
+from ._http_request_protocol import HttpRequestProtocol
+from ._http_response import HttpResponse, HttpResponseFactory
+from ._http_adapter_base import HttpAdapterBase
+from ._channel_service_routes import ChannelServiceRoutes
+
+__all__ = [
+    "HttpRequestProtocol",
+    "HttpResponse",
+    "HttpResponseFactory",
+    "HttpAdapterBase",
+    "ChannelServiceRoutes",
+]

microsoft_agents/hosting/core/http/_channel_service_routes.py

@@ -0,0 +1,202 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""Channel service route definitions (framework-agnostic logic)."""
+
+from typing import Type, List, Union
+
+from microsoft_agents.activity import (
+    AgentsModel,
+    Activity,
+    AttachmentData,
+    ConversationParameters,
+    Transcript,
+)
+from microsoft_agents.hosting.core import ChannelApiHandlerProtocol
+
+from ._http_request_protocol import HttpRequestProtocol
+
+
+class ChannelServiceRoutes:
+    """Defines the Channel Service API routes and their handlers.
+
+    This class provides framework-agnostic route logic that can be
+    adapted to different web frameworks (aiohttp, FastAPI, etc.).
+    """
+
+    def __init__(self, handler: ChannelApiHandlerProtocol, base_url: str = ""):
+        """Initialize channel service routes.
+
+        Args:
+            handler: The handler that implements the Channel API protocol.
+            base_url: Optional base URL prefix for all routes.
+        """
+        self.handler = handler
+        self.base_url = base_url
+
+    @staticmethod
+    async def deserialize_from_body(
+        request: HttpRequestProtocol, target_model: Type[AgentsModel]
+    ) -> AgentsModel:
+        """Deserialize request body to target model."""
+        content_type = request.headers.get("Content-Type", "")
+        if "application/json" not in content_type:
+            raise ValueError("Content-Type must be application/json")
+
+        body = await request.json()
+        return target_model.model_validate(body)
+
+    @staticmethod
+    def serialize_model(model_or_list: Union[AgentsModel, List[AgentsModel]]) -> dict:
+        """Serialize model or list of models to JSON-compatible dict."""
+        if isinstance(model_or_list, AgentsModel):
+            return model_or_list.model_dump(
+                mode="json", exclude_unset=True, by_alias=True
+            )
+        else:
+            return [
+                model.model_dump(mode="json", exclude_unset=True, by_alias=True)
+                for model in model_or_list
+            ]
+
+    # Route handler methods
+    async def send_to_conversation(self, request: HttpRequestProtocol) -> dict:
+        """Handle POST /v3/conversations/{conversation_id}/activities."""
+        activity = await self.deserialize_from_body(request, Activity)
+        conversation_id = request.get_path_param("conversation_id")
+        result = await self.handler.on_send_to_conversation(
+            request.get_claims_identity(),
+            conversation_id,
+            activity,
+        )
+        return self.serialize_model(result)
+
+    async def reply_to_activity(self, request: HttpRequestProtocol) -> dict:
+        """Handle POST /v3/conversations/{conversation_id}/activities/{activity_id}."""
+        activity = await self.deserialize_from_body(request, Activity)
+        conversation_id = request.get_path_param("conversation_id")
+        activity_id = request.get_path_param("activity_id")
+        result = await self.handler.on_reply_to_activity(
+            request.get_claims_identity(),
+            conversation_id,
+            activity_id,
+            activity,
+        )
+        return self.serialize_model(result)
+
+    async def update_activity(self, request: HttpRequestProtocol) -> dict:
+        """Handle PUT /v3/conversations/{conversation_id}/activities/{activity_id}."""
+        activity = await self.deserialize_from_body(request, Activity)
+        conversation_id = request.get_path_param("conversation_id")
+        activity_id = request.get_path_param("activity_id")
+        result = await self.handler.on_update_activity(
+            request.get_claims_identity(),
+            conversation_id,
+            activity_id,
+            activity,
+        )
+        return self.serialize_model(result)
+
+    async def delete_activity(self, request: HttpRequestProtocol) -> None:
+        """Handle DELETE /v3/conversations/{conversation_id}/activities/{activity_id}."""
+        conversation_id = request.get_path_param("conversation_id")
+        activity_id = request.get_path_param("activity_id")
+        await self.handler.on_delete_activity(
+            request.get_claims_identity(),
+            conversation_id,
+            activity_id,
+        )
+
+    async def get_activity_members(self, request: HttpRequestProtocol) -> dict:
+        """Handle GET /v3/conversations/{conversation_id}/activities/{activity_id}/members."""
+        conversation_id = request.get_path_param("conversation_id")
+        activity_id = request.get_path_param("activity_id")
+        result = await self.handler.on_get_activity_members(
+            request.get_claims_identity(),
+            conversation_id,
+            activity_id,
+        )
+        return self.serialize_model(result)
+
+    async def create_conversation(self, request: HttpRequestProtocol) -> dict:
+        """Handle POST /."""
+        conversation_parameters = await self.deserialize_from_body(
+            request, ConversationParameters
+        )
+        result = await self.handler.on_create_conversation(
+            request.get_claims_identity(), conversation_parameters
+        )
+        return self.serialize_model(result)
+
+    async def get_conversations(self, request: HttpRequestProtocol) -> dict:
+        """Handle GET /."""
+        # TODO: continuation token? conversation_id?
+        result = await self.handler.on_get_conversations(
+            request.get_claims_identity(), None
+        )
+        return self.serialize_model(result)
+
+    async def get_conversation_members(self, request: HttpRequestProtocol) -> dict:
+        """Handle GET /v3/conversations/{conversation_id}/members."""
+        conversation_id = request.get_path_param("conversation_id")
+        result = await self.handler.on_get_conversation_members(
+            request.get_claims_identity(),
+            conversation_id,
+        )
+        return self.serialize_model(result)
+
+    async def get_conversation_member(self, request: HttpRequestProtocol) -> dict:
+        """Handle GET /v3/conversations/{conversation_id}/members/{member_id}."""
+        conversation_id = request.get_path_param("conversation_id")
+        member_id = request.get_path_param("member_id")
+        result = await self.handler.on_get_conversation_member(
+            request.get_claims_identity(),
+            member_id,
+            conversation_id,
+        )
+        return self.serialize_model(result)
+
+    async def get_conversation_paged_members(
+        self, request: HttpRequestProtocol
+    ) -> dict:
+        """Handle GET /v3/conversations/{conversation_id}/pagedmembers."""
+        conversation_id = request.get_path_param("conversation_id")
+        # TODO: continuation token? page size?
+        result = await self.handler.on_get_conversation_paged_members(
+            request.get_claims_identity(),
+            conversation_id,
+        )
+        return self.serialize_model(result)
+
+    async def delete_conversation_member(self, request: HttpRequestProtocol) -> dict:
+        """Handle DELETE /v3/conversations/{conversation_id}/members/{member_id}."""
+        conversation_id = request.get_path_param("conversation_id")
+        member_id = request.get_path_param("member_id")
+        result = await self.handler.on_delete_conversation_member(
+            request.get_claims_identity(),
+            conversation_id,
+            member_id,
+        )
+        return self.serialize_model(result)
+
+    async def send_conversation_history(self, request: HttpRequestProtocol) -> dict:
+        """Handle POST /v3/conversations/{conversation_id}/activities/history."""
+        conversation_id = request.get_path_param("conversation_id")
+        transcript = await self.deserialize_from_body(request, Transcript)
+        result = await self.handler.on_send_conversation_history(
+            request.get_claims_identity(),
+            conversation_id,
+            transcript,
+        )
+        return self.serialize_model(result)
+
+    async def upload_attachment(self, request: HttpRequestProtocol) -> dict:
+        """Handle POST /v3/conversations/{conversation_id}/attachments."""
+        conversation_id = request.get_path_param("conversation_id")
+        attachment_data = await self.deserialize_from_body(request, AttachmentData)
+        result = await self.handler.on_upload_attachment(
+            request.get_claims_identity(),
+            conversation_id,
+            attachment_data,
+        )
+        return self.serialize_model(result)

microsoft_agents/hosting/core/http/_http_adapter_base.py

@@ -0,0 +1,136 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""Base HTTP adapter with shared processing logic."""
+
+from abc import ABC
+from traceback import format_exc
+
+from microsoft_agents.activity import Activity, DeliveryModes
+from microsoft_agents.hosting.core.authorization import ClaimsIdentity, Connections
+from microsoft_agents.hosting.core import (
+    Agent,
+    ChannelServiceAdapter,
+    ChannelServiceClientFactoryBase,
+    MessageFactory,
+    RestChannelServiceClientFactory,
+    TurnContext,
+)
+
+from ._http_request_protocol import HttpRequestProtocol
+from ._http_response import HttpResponse, HttpResponseFactory
+
+
+class HttpAdapterBase(ChannelServiceAdapter, ABC):
+    """Base adapter for HTTP-based agent hosting with shared processing logic.
+
+    This class contains all the common logic for processing HTTP requests
+    and can be subclassed by framework-specific adapters (aiohttp, FastAPI, etc).
+    """
+
+    def __init__(
+        self,
+        *,
+        connection_manager: Connections = None,
+        channel_service_client_factory: ChannelServiceClientFactoryBase = None,
+    ):
+        """Initialize the HTTP adapter.
+
+        Args:
+            connection_manager: Optional connection manager for OAuth.
+            channel_service_client_factory: Factory for creating channel service clients.
+        """
+
+        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_request(
+        self, request: HttpRequestProtocol, agent: Agent
+    ) -> HttpResponse:
+        """Process an incoming HTTP request.
+
+        Args:
+            request: The HTTP request to process.
+            agent: The agent to handle the request.
+
+        Returns:
+            HttpResponse with the result.
+
+        Raises:
+            TypeError: If request or agent is None.
+        """
+        if not request:
+            raise TypeError("HttpAdapterBase.process_request: request can't be None")
+        if not agent:
+            raise TypeError("HttpAdapterBase.process_request: agent can't be None")
+
+        if request.method != "POST":
+            return HttpResponseFactory.method_not_allowed()
+
+        # Deserialize the incoming Activity
+        content_type = request.headers.get("Content-Type", "")
+        if "application/json" not in content_type:
+            return HttpResponseFactory.unsupported_media_type()
+
+        try:
+            body = await request.json()
+        except Exception:
+            return HttpResponseFactory.bad_request("Invalid JSON")
+
+        activity: Activity = Activity.model_validate(body)
+
+        # Get claims identity (default to anonymous if not set by middleware)
+        claims_identity: ClaimsIdentity = (
+            request.get_claims_identity() or ClaimsIdentity({}, False)
+        )
+
+        # Validate required activity fields
+        if (
+            not activity.type
+            or not activity.conversation
+            or not activity.conversation.id
+        ):
+            return HttpResponseFactory.bad_request(
+                "Activity must have type and conversation.id"
+            )
+
+        try:
+            # Process the inbound activity with the agent
+            invoke_response = await self.process_activity(
+                claims_identity, activity, agent.on_turn
+            )
+
+            # Check if we need to return a synchronous response
+            if (
+                activity.type == "invoke"
+                or activity.delivery_mode == DeliveryModes.expect_replies
+            ):
+                # Invoke and ExpectReplies cannot be performed async
+                return HttpResponseFactory.json(
+                    invoke_response.body, invoke_response.status
+                )
+
+            return HttpResponseFactory.accepted()
+
+        except PermissionError:
+            return HttpResponseFactory.unauthorized()

microsoft_agents/hosting/core/http/_http_request_protocol.py

@@ -0,0 +1,36 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""Protocol for abstracting HTTP request objects across frameworks."""
+
+from typing import Protocol, Dict, Any, Optional
+
+
+class HttpRequestProtocol(Protocol):
+    """Protocol for HTTP requests that adapters must implement.
+
+    This protocol defines the interface that framework-specific request
+    adapters must implement to work with the shared HTTP adapter logic.
+    """
+
+    @property
+    def method(self) -> str:
+        """HTTP method (GET, POST, etc.)."""
+        ...
+
+    @property
+    def headers(self) -> Dict[str, str]:
+        """Request headers."""
+        ...
+
+    async def json(self) -> Dict[str, Any]:
+        """Parse request body as JSON."""
+        ...
+
+    def get_claims_identity(self) -> Optional[Any]:
+        """Get claims identity attached by auth middleware."""
+        ...
+
+    def get_path_param(self, name: str) -> str:
+        """Get path parameter by name."""
+        ...

microsoft_agents/hosting/core/http/_http_response.py

@@ -0,0 +1,56 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+"""HTTP response abstraction."""
+
+from typing import Any, Optional, Dict
+from dataclasses import dataclass
+
+
+@dataclass
+class HttpResponse:
+    """Framework-agnostic HTTP response."""
+
+    status_code: int
+    body: Optional[Any] = None
+    headers: Optional[Dict[str, str]] = None
+    content_type: Optional[str] = "application/json"
+
+
+class HttpResponseFactory:
+    """Factory for creating HTTP responses."""
+
+    @staticmethod
+    def ok(body: Any = None) -> HttpResponse:
+        """Create 200 OK response."""
+        return HttpResponse(status_code=200, body=body)
+
+    @staticmethod
+    def accepted() -> HttpResponse:
+        """Create 202 Accepted response."""
+        return HttpResponse(status_code=202)
+
+    @staticmethod
+    def json(body: Any, status_code: int = 200) -> HttpResponse:
+        """Create JSON response."""
+        return HttpResponse(status_code=status_code, body=body)
+
+    @staticmethod
+    def bad_request(message: str = "Bad Request") -> HttpResponse:
+        """Create 400 Bad Request response."""
+        return HttpResponse(status_code=400, body={"error": message})
+
+    @staticmethod
+    def unauthorized(message: str = "Unauthorized") -> HttpResponse:
+        """Create 401 Unauthorized response."""
+        return HttpResponse(status_code=401, body={"error": message})
+
+    @staticmethod
+    def method_not_allowed(message: str = "Method Not Allowed") -> HttpResponse:
+        """Create 405 Method Not Allowed response."""
+        return HttpResponse(status_code=405, body={"error": message})
+
+    @staticmethod
+    def unsupported_media_type(message: str = "Unsupported Media Type") -> HttpResponse:
+        """Create 415 Unsupported Media Type response."""
+        return HttpResponse(status_code=415, body={"error": message})

{microsoft_agents_hosting_core-0.7.0.dev0.dist-info → microsoft_agents_hosting_core-0.7.0.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 0.7.0.dev0
+Version: 0.7.0.dev1
 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.7.0.dev0
+Requires-Dist: microsoft-agents-activity==0.7.0.dev1
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: azure-core>=1.30.0

{microsoft_agents_hosting_core-0.7.0.dev0.dist-info → microsoft_agents_hosting_core-0.7.0.dev1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-microsoft_agents/hosting/core/__init__.py,sha256=jZ0551xg2RnMtHpAMD1AtXyDh0oPUSDYPe_S9QNdbtA,5012
+microsoft_agents/hosting/core/__init__.py,sha256=iPlMZNnfGWwNe52937iqpDx40szMXzcYm_T2E6iFkag,5459
 microsoft_agents/hosting/core/activity_handler.py,sha256=1hsSmVCnQLS44RK05v8j6mlmV38_JGmJTPR9LkogQuc,27779
 microsoft_agents/hosting/core/agent.py,sha256=K8v84y8ULP7rbcMKg8LxaM3haAq7f1oHFCLy3AAphQE,574
 microsoft_agents/hosting/core/card_factory.py,sha256=UDmPEpOk2SpEr9ShN9Q0CiaI_GTD3qjHgkDMOWinW9I,6926
@@ -40,6 +40,10 @@ microsoft_agents/hosting/core/app/state/conversation_state.py,sha256=LfcSwvhaU0J
 microsoft_agents/hosting/core/app/state/state.py,sha256=mbNrHuAc7d9vJep3PtExbLFtfKxZoAUX3Jr45GT3SuA,7373
 microsoft_agents/hosting/core/app/state/temp_state.py,sha256=Oh7K5-uYf50Z-lBXqttSMl2N1lRakktOmjLlIAKcEsM,3501
 microsoft_agents/hosting/core/app/state/turn_state.py,sha256=rEIRkwBsn3MPbrfKNjX8XqqbF-4THepMXU75KvDsBvM,9868
+microsoft_agents/hosting/core/app/streaming/__init__.py,sha256=LtchDJTb25owxcbDd1sWr0BtGHK-PQboxCX4oNiN89c,329
+microsoft_agents/hosting/core/app/streaming/citation.py,sha256=ZGaMUOWxxoMplwRrkFsjnK7Z12V6rT5odE7qZCu-mP8,498
+microsoft_agents/hosting/core/app/streaming/citation_util.py,sha256=c95c3Y3genmFc0vSXppPaD1-ShFohAV1UABZnyJS_BQ,2478
+microsoft_agents/hosting/core/app/streaming/streaming_response.py,sha256=uwNYaVJ8cghdjHS_Y8ZeOiYnpyeQGHt0rQQlay6a-C8,13799
 microsoft_agents/hosting/core/authorization/__init__.py,sha256=pOTmTJFS5CMPEcHRadBTgrbWUP5lOIxsPMgTreFq7mw,634
 microsoft_agents/hosting/core/authorization/access_token_provider_base.py,sha256=Z0nGkfOUSIBvJSFjGGNQEd1-upqZVjT6eSXsqsFa2Cc,1646
 microsoft_agents/hosting/core/authorization/agent_auth_configuration.py,sha256=meLUO0Mwb9SBr01dLvYS9q3xuZyndCsb_gIx0r7__Sk,2944
@@ -78,6 +82,11 @@ microsoft_agents/hosting/core/connector/teams/__init__.py,sha256=3ZMPGYyZ15EwvfQ
 microsoft_agents/hosting/core/connector/teams/teams_connector_client.py,sha256=XGQDTYHrA_I9n9JlxGST5eesjsFhz2dnSaMSuyoFnKU,12676
 microsoft_agents/hosting/core/errors/__init__.py,sha256=kcfwDGDaopWfLyvYsNXM6j4cYt2oGKysjCRDezcVY0A,500
 microsoft_agents/hosting/core/errors/error_resources.py,sha256=_nyvPQaX3gpi9kziajVdzGWCzMa6JcTntK__zQJlGMo,3922
+microsoft_agents/hosting/core/http/__init__.py,sha256=Jh6lIivBN9YsNaLPzYvzvbhLAwJbeQTSRHtFupfSy-I,532
+microsoft_agents/hosting/core/http/_channel_service_routes.py,sha256=80IWoUDKywUurXnh7vmG0QMxu3sk7W38zgHsw0eJ2DA,8436
+microsoft_agents/hosting/core/http/_http_adapter_base.py,sha256=qRqAwMl1Wsq_A1J6asMMcS9jUGjlLD3HF-0Sioba5IM,4561
+microsoft_agents/hosting/core/http/_http_request_protocol.py,sha256=YTfcp_K1IswAIWVQ5QFBTyX-ssuUo6BChdlPHEh-t4Q,1002
+microsoft_agents/hosting/core/http/_http_response.py,sha256=e_bY0bJJXx--Zb_Yd-f9iDPFbK4bWkFi92a0nq1A6us,1862
 microsoft_agents/hosting/core/state/__init__.py,sha256=yckKi1wg_86ng-DL9Q3R49QiWKvNjPkVNk6HClWgVrY,208
 microsoft_agents/hosting/core/state/agent_state.py,sha256=uboptWaC3VrSGTnXIzaO38XUqOT-ITW6EhJxuGMtKWs,13724
 microsoft_agents/hosting/core/state/state_property_accessor.py,sha256=kpiNnzkZ6el-oRITRbRkk1Faa_CPFxpJQdvSGxIJP70,1392
@@ -93,8 +102,8 @@ microsoft_agents/hosting/core/storage/transcript_info.py,sha256=5VN32j99tshChAff
 microsoft_agents/hosting/core/storage/transcript_logger.py,sha256=_atDk3CJ05fIVMhlWGNa91IiM9bGLmOhasFko8Lxjhk,8237
 microsoft_agents/hosting/core/storage/transcript_memory_store.py,sha256=v1Ud9LSs8m5c9_Fa8i49SuAjw80dX1hDciqbRduDEOE,6444
 microsoft_agents/hosting/core/storage/transcript_store.py,sha256=ka74o0WvI5GhMZcFqSxVdamBhGzZcDZe6VNkG-sMy74,1944
-microsoft_agents_hosting_core-0.7.0.dev0.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
-microsoft_agents_hosting_core-0.7.0.dev0.dist-info/METADATA,sha256=kum-N0M9RQKtwhrewQsTH8JkWJXgo1Fqnr5yjD--cmc,9242
-microsoft_agents_hosting_core-0.7.0.dev0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-microsoft_agents_hosting_core-0.7.0.dev0.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
-microsoft_agents_hosting_core-0.7.0.dev0.dist-info/RECORD,,
+microsoft_agents_hosting_core-0.7.0.dev1.dist-info/licenses/LICENSE,sha256=ws_MuBL-SCEBqPBFl9_FqZkaaydIJmxHrJG2parhU4M,1141
+microsoft_agents_hosting_core-0.7.0.dev1.dist-info/METADATA,sha256=uTABUKgX0loiJoQtHm-MQVfr7QrmbtqyoRyl7zeLf-8,9242
+microsoft_agents_hosting_core-0.7.0.dev1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+microsoft_agents_hosting_core-0.7.0.dev1.dist-info/top_level.txt,sha256=lWKcT4v6fTA_NgsuHdNvuMjSrkiBMXohn64ApY7Xi8A,17
+microsoft_agents_hosting_core-0.7.0.dev1.dist-info/RECORD,,