microsoft-agents-hosting-core 0.9.0.dev1__tar.gz → 0.9.0.dev3__tar.gz

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/PKG-INFO

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

microsoft_agents_hosting_core-0.9.0.dev3/VERSION.txt

@@ -0,0 +1 @@
+0.9.0.dev3

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/microsoft_agents/hosting/core/app/streaming/streaming_response.py

@@ -1,22 +1,26 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
+import uuid
 import asyncio
 import logging
-from typing import List, Optional, Callable, Literal, TYPE_CHECKING
+from typing import List, Optional, Callable, Literal, cast
 
 from microsoft_agents.activity import (
     Activity,
+    AIEntity,
     Entity,
+    EntityTypes,
     Attachment,
     Channels,
     ClientCitation,
     DeliveryModes,
     SensitivityUsageInfo,
+    ClientCitationAppearance,
+    StreamInfo,
 )
 
-if TYPE_CHECKING:
-    from microsoft_agents.hosting.core.turn_context import TurnContext
+from microsoft_agents.hosting.core.errors import error_resources
 
 from .citation import Citation
 from .citation_util import CitationUtil
@@ -47,58 +51,38 @@ class StreamingResponse:
         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: List[Callable[[], Activity | None]] = []
         self._queue_sync: Optional[asyncio.Task] = None
         self._chunk_queued = False
-
-        # Powered by AI feature flags
+        self._ended = False
+        self._cancelled = False
+        self._is_streaming_channel = False
+        self._interval = 0.1
+        self._attachments: Optional[List[Attachment]] = None
+        self._citations: List[ClientCitation] = []
+        self._sensitivity_label: Optional[SensitivityUsageInfo] = None
         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
+        # Set defaults based on channel
         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.
 
+        Informative updates do not contain the message content that the user will
+        read but rather an indication that the agent is processing the request.
+
         Args:
-            text: Text of the update to send.
+            text: The informative text to send to the client.
         """
-        if not self._is_streaming_channel:
+        if self._cancelled or not self._is_streaming_channel:
             return
 
         if self._ended:
-            raise RuntimeError("The stream has already ended.")
+            raise RuntimeError(str(error_resources.StreamAlreadyEnded))
 
         # Queue a typing activity
         def create_activity():
@@ -106,8 +90,7 @@ class StreamingResponse:
                 type="typing",
                 text=text,
                 entities=[
-                    Entity(
-                        type="streaminfo",
+                    StreamInfo(
                         stream_type="informative",
                         stream_sequence=self._sequence_number,
                     )
@@ -134,7 +117,7 @@ class StreamingResponse:
         if self._cancelled:
             return
         if self._ended:
-            raise RuntimeError("The stream has already ended.")
+            raise RuntimeError(str(error_resources.StreamAlreadyEnded))
 
         # Update full message text
         self._message += text
@@ -150,7 +133,7 @@ class StreamingResponse:
         Ends the stream by sending the final message to the client.
         """
         if self._ended:
-            raise RuntimeError("The stream has already ended.")
+            raise RuntimeError(str(error_resources.StreamAlreadyEnded))
 
         # Queue final message
         self._ended = True
@@ -192,13 +175,12 @@ class StreamingResponse:
 
             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),
-                    },
+                    appearance=ClientCitationAppearance(
+                        name=citation.title or f"Document #{curr_pos + 1}",
+                        abstract=CitationUtil.snippet(citation.content, 480),
+                        url=citation.url,
+                    ),
                 )
                 curr_pos += 1
                 self._citations.append(client_citation)
@@ -249,17 +231,29 @@ class StreamingResponse:
             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:
+
+        channel = (
+            context.activity.channel_id.channel if context.activity.channel_id else None
+        )
+
+        if channel == Channels.ms_teams:
+            if context.activity.is_agentic_request():
+                # Agentic requests do not support streaming responses at this time.
+                # TODO : Enable streaming for agentic requests when supported.
+                self._is_streaming_channel = False
+            else:
+                self._is_streaming_channel = True
+                self._interval = 1.0
+        elif channel in [Channels.webchat, Channels.direct_line]:
             self._is_streaming_channel = True
             self._interval = 0.5
+            self._stream_id = str(uuid.uuid4())
         elif context.activity.delivery_mode == DeliveryModes.stream:
             self._is_streaming_channel = True
             self._interval = 0.1
-
-        self._channel_id = context.activity.channel_id
+            self._stream_id = str(uuid.uuid4())
+        else:
+            self._is_streaming_channel = False
 
     def _queue_next_chunk(self) -> None:
         """
@@ -272,7 +266,7 @@ class StreamingResponse:
         # Queue a chunk of text to be sent
         self._chunk_queued = True
 
-        def create_activity():
+        def create_activity() -> Activity | None:
             self._chunk_queued = False
             if self._ended:
                 # Send final message
@@ -281,9 +275,7 @@ class StreamingResponse:
                     text=self._message or "end stream response",
                     attachments=self._attachments or [],
                     entities=[
-                        Entity(
-                            type="streaminfo",
-                            stream_id=self._stream_id,
+                        StreamInfo(
                             stream_type="final",
                             stream_sequence=self._sequence_number,
                         )
@@ -295,8 +287,7 @@ class StreamingResponse:
                     type="typing",
                     text=self._message,
                     entities=[
-                        Entity(
-                            type="streaminfo",
+                        StreamInfo(
                             stream_type="streaming",
                             stream_sequence=self._sequence_number,
                         )
@@ -309,7 +300,7 @@ class StreamingResponse:
 
         self._queue_activity(create_activity)
 
-    def _queue_activity(self, factory: Callable[[], Activity]) -> None:
+    def _queue_activity(self, factory: Callable[[], Activity | None]) -> None:
         """
         Queues an activity to be sent to the client.
         """
@@ -331,15 +322,15 @@ class StreamingResponse:
                 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
+            if "403" in str(err) and (
+                self._context.activity.channel_id is not None
+                and self._context.activity.channel_id.channel == 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}"
+                    f"Error occurred when sending activity while streaming: {type(err).__name__}"
                 )
                 raise
         finally:
@@ -353,20 +344,22 @@ class StreamingResponse:
             activity: The activity to send.
         """
 
-        streaminfo_entity = None
+        streaminfo_entity: StreamInfo | None = None
 
         if not activity.entities:
-            streaminfo_entity = Entity(type="streaminfo")
+            streaminfo_entity = StreamInfo(stream_sequence=self._sequence_number)
+            self._sequence_number += 1
             activity.entities = [streaminfo_entity]
         else:
             for entity in activity.entities:
-                if hasattr(entity, "type") and entity.type == "streaminfo":
-                    streaminfo_entity = entity
+                if entity.type == EntityTypes.STREAM_INFO:
+                    streaminfo_entity = cast(StreamInfo, entity)
                     break
 
             if not streaminfo_entity:
                 # If no streaminfo entity exists, create one
-                streaminfo_entity = Entity(type="streaminfo")
+                streaminfo_entity = StreamInfo(stream_sequence=self._sequence_number)
+                self._sequence_number += 1
                 activity.entities.append(streaminfo_entity)
 
         # Set activity ID to the assigned stream ID
@@ -374,17 +367,21 @@ class StreamingResponse:
             activity.id = self._stream_id
             streaminfo_entity.stream_id = self._stream_id
 
-        if self._citations and len(self._citations) > 0 and not self._ended:
+        # the activity.add_ai_metadata call further down will add citations.
+        # The extra condition here is to avoid duplication
+        if (
+            self._citations
+            and not self._ended
+            and not self._enable_generated_by_ai_label
+        ):
             # Filter out the citations unused in content.
             curr_citations = CitationUtil.get_used_citations(
                 self._message, self._citations
             )
             if curr_citations:
                 activity.entities.append(
-                    Entity(
+                    AIEntity(
                         type="https://schema.org/Message",
-                        schema_type="Message",
-                        context="https://schema.org",
                         id="",
                         citation=curr_citations,
                     )
@@ -400,7 +397,10 @@ class StreamingResponse:
                 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)
+            curr_citations = CitationUtil.get_used_citations(
+                self._message, self._citations
+            )
+            activity.add_ai_metadata(curr_citations, self._sensitivity_label)
 
         # Send activity
         response = await self._context.send_activity(activity)

microsoft_agents_hosting_core-0.9.0.dev3/microsoft_agents/hosting/core/authorization/jwt_token_validator.py

@@ -0,0 +1,116 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import asyncio
+import logging
+import threading
+from typing import Any
+from dataclasses import dataclass
+
+from jwt import PyJWKClient, PyJWK, decode, get_unverified_header
+
+from .agent_auth_configuration import AgentAuthConfiguration
+from .claims_identity import ClaimsIdentity
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class _JwkClientCacheEntry:
+
+    jwk_client: PyJWKClient
+    lock: threading.Lock
+
+
+class _JwkClientManager:
+    """Helper class to manage PyJWKClient instances for different JWKS URIs, with caching and async-safety"""
+
+    _cache: dict[str, _JwkClientCacheEntry]
+
+    def __init__(self):
+        self._cache = {}
+
+    def _get_jwk_client(self, jwks_uri: str) -> _JwkClientCacheEntry:
+        """Retrieves a PyJWKClient for the given JWKS URI, using a cache to avoid creating multiple clients for the same URI."""
+        if jwks_uri not in self._cache:
+            self._cache[jwks_uri] = _JwkClientCacheEntry(
+                PyJWKClient(jwks_uri), threading.Lock()
+            )
+        return self._cache[jwks_uri]
+
+    async def get_signing_key(self, jwks_uri: str, header: dict[str, Any]) -> PyJWK:
+        """Retrieves the signing key from the JWK client for the given token header."""
+
+        jwk_cache_entry = self._get_jwk_client(jwks_uri)
+
+        # locking and creating a new thread seems strange,
+        # but PyJWKClient.get_signing_key is synchronous, so we spawn another thread
+        # to make the call non-blocking, allowing other queued coroutines to run in the meantime.
+        # Meanwhile, the lock ensures safety for the PyJWKClient's underlying cache and
+        # prevents duplicate calls to the JWKS endpoint for the same URI when multiple
+        # coroutines are trying to get signing keys concurrently.
+
+        def _helper():
+            with jwk_cache_entry.lock:
+                return jwk_cache_entry.jwk_client.get_signing_key(header["kid"])
+
+        key = await asyncio.to_thread(_helper)
+        return key
+
+
+class JwtTokenValidator:
+    """Utility class for validating JWT tokens using the PyJWT library and JWKs from a specified URI."""
+
+    _jwk_client_manager = _JwkClientManager()
+
+    def __init__(self, configuration: AgentAuthConfiguration):
+        """Initializes the JwtTokenValidator with the given configuration.
+
+        :param configuration: An instance of AgentAuthConfiguration containing the necessary settings for token validation.
+        """
+        self.configuration = configuration
+
+    async def validate_token(self, token: str) -> ClaimsIdentity:
+        """Validates a JWT token.
+
+        :param token: The JWT token to validate.
+        :return: A ClaimsIdentity object containing the token's claims if validation is successful.
+        :raises ValueError: If the token is invalid or if the audience claim is not valid
+        """
+
+        logger.debug("Validating JWT token.")
+        key = await self._get_public_key_or_secret(token)
+        decoded_token = decode(
+            token,
+            key=key,
+            algorithms=["RS256"],
+            leeway=300.0,
+            options={"verify_aud": False},
+        )
+        if not self.configuration._jwt_patch_is_valid_aud(decoded_token["aud"]):
+            logger.error(f"Invalid audience: {decoded_token['aud']}", stack_info=True)
+            raise ValueError("Invalid audience.")
+
+        # This probably should return a ClaimsIdentity
+        logger.debug("JWT token validated successfully.")
+        return ClaimsIdentity(decoded_token, True, security_token=token)
+
+    def get_anonymous_claims(self) -> ClaimsIdentity:
+        """Returns a ClaimsIdentity for an anonymous user."""
+        logger.debug("Returning anonymous claims identity.")
+        return ClaimsIdentity({}, False, authentication_type="Anonymous")
+
+    async def _get_public_key_or_secret(self, token: str) -> PyJWK:
+        """Retrieves the public key or secret for validating the JWT token."""
+        header = get_unverified_header(token)
+        unverified_payload: dict = decode(token, options={"verify_signature": False})
+
+        jwks_uri = (
+            "https://login.botframework.com/v1/.well-known/keys"
+            if unverified_payload.get("iss") == "https://api.botframework.com"
+            else f"https://login.microsoftonline.com/{self.configuration.TENANT_ID}/discovery/v2.0/keys"
+        )
+
+        key = await self._jwk_client_manager.get_signing_key(jwks_uri, header)
+
+        return key

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/microsoft_agents/hosting/core/connector/client/connector_client.py

@@ -311,7 +311,7 @@ class ConversationsOperations(ConversationsBase):
         )
         async with self.client.put(
             url,
-            json=body.model_dump(by_alias=True, exclude_unset=True),
+            json=body.model_dump(exclude_unset=True, by_alias=True),
         ) as response:
             if response.status >= 300:
                 logger.error(

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/microsoft_agents/hosting/core/turn_context.py

@@ -142,15 +142,9 @@ class TurnContext(TurnContextProtocol):
         """
         # Use lazy import to avoid circular dependency
         if not hasattr(self, "_streaming_response"):
-            try:
-                from microsoft_agents.hosting.aiohttp.app.streaming import (
-                    StreamingResponse,
-                )
+            from microsoft_agents.hosting.core.app.streaming import StreamingResponse
 
-                self._streaming_response = StreamingResponse(self)
-            except ImportError:
-                # If the hosting library isn't available, return None
-                self._streaming_response = None
+            self._streaming_response = StreamingResponse(self)
         return self._streaming_response
 
     @property

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/microsoft_agents_hosting_core.egg-info/PKG-INFO

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

{microsoft_agents_hosting_core-0.9.0.dev1 → microsoft_agents_hosting_core-0.9.0.dev3}/microsoft_agents_hosting_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-microsoft-agents-activity==0.9.0.dev1
+microsoft-agents-activity==0.9.0.dev3
 pyjwt>=2.10.1
 isodate>=0.6.1
 azure-core>=1.30.0

microsoft_agents_hosting_core-0.9.0.dev1/VERSION.txt

@@ -1 +0,0 @@
-0.9.0.dev1

microsoft_agents_hosting_core-0.9.0.dev1/microsoft_agents/hosting/core/authorization/jwt_token_validator.py

@@ -1,56 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-
-import asyncio
-import logging
-import jwt
-
-from jwt import PyJWKClient, PyJWK, decode, get_unverified_header
-
-from .agent_auth_configuration import AgentAuthConfiguration
-from .claims_identity import ClaimsIdentity
-
-logger = logging.getLogger(__name__)
-
-
-class JwtTokenValidator:
-    def __init__(self, configuration: AgentAuthConfiguration):
-        self.configuration = configuration
-
-    async def validate_token(self, token: str) -> ClaimsIdentity:
-
-        logger.debug("Validating JWT token.")
-        key = await self._get_public_key_or_secret(token)
-        decoded_token = jwt.decode(
-            token,
-            key=key,
-            algorithms=["RS256"],
-            leeway=300.0,
-            options={"verify_aud": False},
-        )
-        if not self.configuration._jwt_patch_is_valid_aud(decoded_token["aud"]):
-            logger.error(f"Invalid audience: {decoded_token['aud']}", stack_info=True)
-            raise ValueError("Invalid audience.")
-
-        # This probably should return a ClaimsIdentity
-        logger.debug("JWT token validated successfully.")
-        return ClaimsIdentity(decoded_token, True, security_token=token)
-
-    def get_anonymous_claims(self) -> ClaimsIdentity:
-        logger.debug("Returning anonymous claims identity.")
-        return ClaimsIdentity({}, False, authentication_type="Anonymous")
-
-    async def _get_public_key_or_secret(self, token: str) -> PyJWK:
-        header = get_unverified_header(token)
-        unverified_payload: dict = decode(token, options={"verify_signature": False})
-
-        jwksUri = (
-            "https://login.botframework.com/v1/.well-known/keys"
-            if unverified_payload.get("iss") == "https://api.botframework.com"
-            else f"https://login.microsoftonline.com/{self.configuration.TENANT_ID}/discovery/v2.0/keys"
-        )
-        jwks_client = PyJWKClient(jwksUri)
-
-        key = await asyncio.to_thread(jwks_client.get_signing_key, header["kid"])
-
-        return key