microsoft-agents-activity 0.9.0.dev2__tar.gz → 0.9.0.dev3__tar.gz

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-activity
-Version: 0.9.0.dev2
+Version: 0.9.0.dev3
 Summary: A protocol library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT

microsoft_agents_activity-0.9.0.dev3/VERSION.txt

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

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/__init__.py

@@ -44,6 +44,7 @@ from .entity import (
     Place,
     ProductInfo,
     Thing,
+    StreamInfo,
 )
 from .error import Error
 from .error_response import ErrorResponse
@@ -133,6 +134,7 @@ __all__ = [
     "ExpectedReplies",
     "Entity",
     "AIEntity",
+    "EntityTypes",
     "ClientCitation",
     "ClientCitationAppearance",
     "ClientCitationImage",
@@ -154,6 +156,7 @@ __all__ = [
     "OAuthCard",
     "PagedMembersResult",
     "Place",
+    "StreamInfo",
     "ProductInfo",
     "ReceiptCard",
     "ReceiptItem",

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/activity.py

@@ -754,9 +754,6 @@ class Activity(AgentsModel, _ChannelIdFieldMixin):
         """
         if citations:
             ai_entity = AIEntity(
-                type="https://schema.org/Message",
-                schema_type="Message",
-                context="https://schema.org",
                 id="",
                 additional_type=["AIGeneratedContent"],
                 citation=citations,

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/agents_model.py

@@ -8,7 +8,9 @@ from pydantic.alias_generators import to_camel
 
 
 class AgentsModel(BaseModel):
-    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    model_config = ConfigDict(
+        alias_generator=to_camel, validate_by_name=True, validate_by_alias=True
+    )
 
     """
     @model_serializer

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/entity/__init__.py

@@ -16,6 +16,7 @@ from .ai_entity import (
 from .geo_coordinates import GeoCoordinates
 from .place import Place
 from .product_info import ProductInfo
+from .stream_info import StreamInfo
 from .thing import Thing
 
 __all__ = [
@@ -29,6 +30,7 @@ __all__ = [
     "Mention",
     "SensitivityUsageInfo",
     "SensitivityPattern",
+    "StreamInfo",
     "GeoCoordinates",
     "Place",
     "ProductInfo",

microsoft_agents_activity-0.9.0.dev3/microsoft_agents/activity/entity/_schema_mixin.py

@@ -0,0 +1,55 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
+from pydantic import (
+    model_serializer,
+    model_validator,
+    ModelWrapValidatorHandler,
+    SerializerFunctionWrapHandler,
+    SerializationInfo,
+    BaseModel,
+)
+
+
+def validate_schema_model(data: Any, handler: ModelWrapValidatorHandler):
+    """Custom validator to handle the aliases @type, @context, and @id if defined in the destination type."""
+    model = handler(data)
+    if isinstance(data, dict):
+        if "@type" in data:
+            setattr(model, "at_type", data["@type"])
+        if "@context" in data:
+            setattr(model, "at_context", data["@context"])
+        if "@id" in data:
+            setattr(model, "at_id", data["@id"])
+    return model
+
+
+def serialize_schema_model(
+    self, handler: SerializerFunctionWrapHandler, info: SerializationInfo
+) -> dict[str, Any]:
+    """Custom serializer to convert keys to force inclusion of @type, @context, and @id if defined."""
+    serialized = handler(self)
+    if info.by_alias:
+        if hasattr(self, "at_type"):
+            serialized["@type"] = getattr(self, "at_type")
+        if hasattr(self, "at_context"):
+            serialized["@context"] = getattr(self, "at_context")
+        if hasattr(self, "at_id"):
+            serialized["@id"] = getattr(self, "at_id")
+    return serialized
+
+
+class _SchemaMixin(BaseModel):
+    """Mixin class to force inclusion of @property fields when serializing."""
+
+    @model_validator(mode="wrap")
+    @classmethod
+    def _validate_model(cls, data: Any, handler: ModelWrapValidatorHandler):
+        return validate_schema_model(data, handler)
+
+    @model_serializer(mode="wrap")
+    def _serialize_model(
+        self, handler: SerializerFunctionWrapHandler, info: SerializationInfo
+    ) -> dict[str, Any]:
+        return serialize_schema_model(self, handler, info)

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/entity/ai_entity.py

@@ -2,10 +2,11 @@
 # Licensed under the MIT License.
 
 from enum import Enum
-from typing import List, Optional, Union, Literal
-from dataclasses import dataclass
+from typing import List, Optional, Literal
 
+from pydantic import Field
 from ..agents_model import AgentsModel
+from ._schema_mixin import _SchemaMixin
 from .entity import Entity
 
 
@@ -42,33 +43,36 @@ class ClientCitationImage(AgentsModel):
     name: str = ""
 
 
-class SensitivityPattern(AgentsModel):
+class SensitivityPattern(AgentsModel, _SchemaMixin):
     """Pattern information for sensitivity usage info."""
 
-    type: str = "DefinedTerm"
+    at_type: Literal["DefinedTerm"] = "DefinedTerm"
+
     in_defined_term_set: str = ""
     name: str = ""
     term_code: str = ""
 
 
-class SensitivityUsageInfo(AgentsModel):
+class SensitivityUsageInfo(AgentsModel, _SchemaMixin):
     """
     Sensitivity usage info for content sent to the user.
     This is used to provide information about the content to the user.
     """
 
     type: str = "https://schema.org/Message"
-    schema_type: str = "CreativeWork"
+    at_type: Literal["CreativeWork"] = "CreativeWork"
+
     description: Optional[str] = None
     name: str = ""
     position: Optional[int] = None
     pattern: Optional[SensitivityPattern] = None
 
 
-class ClientCitationAppearance(AgentsModel):
+class ClientCitationAppearance(AgentsModel, _SchemaMixin):
     """Appearance information for a client citation."""
 
-    type: str = "DigitalDocument"
+    at_type: Literal["DigitalDocument"] = "DigitalDocument"
+
     name: str = ""
     text: Optional[str] = None
     url: Optional[str] = None
@@ -79,33 +83,30 @@ class ClientCitationAppearance(AgentsModel):
     usage_info: Optional[SensitivityUsageInfo] = None
 
 
-class ClientCitation(AgentsModel):
+class ClientCitation(AgentsModel, _SchemaMixin):
     """
     Represents a Teams client citation to be included in a message.
     See Bot messages with AI-generated content for more details.
     https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage
     """
 
-    type: str = "Claim"
-    position: int = 0
-    appearance: Optional[ClientCitationAppearance] = None
+    at_type: Literal["Claim"] = "Claim"
 
-    def __post_init__(self):
-        if self.appearance is None:
-            self.appearance = ClientCitationAppearance()
+    position: int = 0
+    appearance: ClientCitationAppearance = Field(
+        default_factory=ClientCitationAppearance
+    )
 
 
 class AIEntity(Entity):
     """Entity indicating AI-generated content."""
 
+    at_type: Literal["Message"] = "Message"
+    at_context: Literal["https://schema.org"] = "https://schema.org"
+
     type: str = "https://schema.org/Message"
-    schema_type: str = "Message"
-    context: str = "https://schema.org"
     id: str = ""
-    additional_type: Optional[List[str]] = None
+
+    additional_type: List[str] = Field(default_factory=lambda: ["AIGeneratedContent"])
     citation: Optional[List[ClientCitation]] = None
     usage_info: Optional[SensitivityUsageInfo] = None
-
-    def __post_init__(self):
-        if self.additional_type is None:
-            self.additional_type = ["AIGeneratedContent"]

microsoft_agents_activity-0.9.0.dev3/microsoft_agents/activity/entity/entity.py

@@ -0,0 +1,76 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
+
+from pydantic import (
+    model_serializer,
+    model_validator,
+    SerializationInfo,
+    ModelWrapValidatorHandler,
+    SerializerFunctionWrapHandler,
+)
+from pydantic.alias_generators import to_camel, to_snake
+
+from ..agents_model import AgentsModel, ConfigDict
+from ._schema_mixin import validate_schema_model, serialize_schema_model
+
+
+def _to_camel_exclude_at(k: str) -> str:
+    """Helper function to convert keys to camelCase while preserving keys that start with '@'."""
+    if k.startswith("@"):
+        return k  # preserve keys starting with '@'
+    return to_camel(k)
+
+
+class Entity(AgentsModel):
+    """Metadata object pertaining to an activity.
+
+    :param type: Type of this entity (RFC 3987 IRI)
+    :type type: str
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+        alias_generator=to_camel,
+        validate_by_name=True,
+        validate_by_alias=True,
+    )
+
+    type: str
+
+    @property
+    def additional_properties(self) -> dict[str, Any]:
+        """Returns the set of properties that are not None."""
+        return self.model_extra
+
+    @model_validator(mode="wrap")
+    @classmethod
+    def _validate_model(cls, data: Any, handler: ModelWrapValidatorHandler):
+        """Custom validator to handle both camelCase and snake_case keys, as well as @type, @context, and @id."""
+
+        if isinstance(data, dict):
+            new_data = {to_snake(k): v for k, v in data.items()}
+            return validate_schema_model(new_data, handler)
+        return validate_schema_model(data, handler)
+
+    @model_serializer(mode="wrap")
+    def _serialize_model(
+        self, handler: SerializerFunctionWrapHandler, info: SerializationInfo
+    ) -> dict[str, object]:
+        """Custom serializer to convert keys to camelCase and include @type, @context, and @id as needed.
+
+        Forces the inclusion of the 'type' field in the serialized output, as it is a required field for Entity.
+        """
+
+        data = serialize_schema_model(self, handler, info)
+        new_data: dict
+
+        if info.by_alias:
+            new_data = {_to_camel_exclude_at(k): v for k, v in data.items()}
+        else:
+            new_data = {k: v for k, v in data.items()}
+
+        new_data["type"] = self.type  # ensure type is always included
+
+        return new_data

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/entity/entity_types.py

@@ -12,3 +12,4 @@ class EntityTypes(str, Enum):
     PLACE = "Place"
     THING = "Thing"
     PRODUCT_INFO = "ProductInfo"
+    STREAM_INFO = "streaminfo"

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents/activity/entity/product_info.py

@@ -16,5 +16,5 @@ class ProductInfo(Entity):
     :type id: str
     """
 
-    type: Literal[EntityTypes.PRODUCT_INFO] = EntityTypes.PRODUCT_INFO
+    type: Literal[EntityTypes.PRODUCT_INFO.value] = EntityTypes.PRODUCT_INFO.value
     id: str = None

microsoft_agents_activity-0.9.0.dev3/microsoft_agents/activity/entity/stream_info.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class StreamInfo(Entity):
+
+    type: str = EntityTypes.STREAM_INFO.value
+
+    stream_type: NonEmptyString = "streaming"
+    stream_sequence: int
+
+    stream_id: str = ""
+    stream_result: str = ""
+
+    feedback_loop_enabled: bool = False
+    feedback_loop: dict | None = None

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents_activity.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-activity
-Version: 0.9.0.dev2
+Version: 0.9.0.dev3
 Summary: A protocol library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT

{microsoft_agents_activity-0.9.0.dev2 → microsoft_agents_activity-0.9.0.dev3}/microsoft_agents_activity.egg-info/SOURCES.txt

@@ -91,6 +91,7 @@ microsoft_agents/activity/config/__init__.py
 microsoft_agents/activity/config/_configure_logging.py
 microsoft_agents/activity/config/_load_configuration.py
 microsoft_agents/activity/entity/__init__.py
+microsoft_agents/activity/entity/_schema_mixin.py
 microsoft_agents/activity/entity/ai_entity.py
 microsoft_agents/activity/entity/entity.py
 microsoft_agents/activity/entity/entity_types.py
@@ -98,6 +99,7 @@ microsoft_agents/activity/entity/geo_coordinates.py
 microsoft_agents/activity/entity/mention.py
 microsoft_agents/activity/entity/place.py
 microsoft_agents/activity/entity/product_info.py
+microsoft_agents/activity/entity/stream_info.py
 microsoft_agents/activity/entity/thing.py
 microsoft_agents/activity/errors/__init__.py
 microsoft_agents/activity/errors/error_message.py

microsoft_agents_activity-0.9.0.dev2/VERSION.txt

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

microsoft_agents_activity-0.9.0.dev2/microsoft_agents/activity/entity/entity.py

@@ -1,41 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-
-from typing import Any
-
-from pydantic import model_serializer, model_validator
-from pydantic.alias_generators import to_camel, to_snake
-
-from ..agents_model import AgentsModel, ConfigDict
-
-
-class Entity(AgentsModel):
-    """Metadata object pertaining to an activity.
-
-    :param type: Type of this entity (RFC 3987 IRI)
-    :type type: str
-    """
-
-    model_config = ConfigDict(extra="allow")
-
-    type: str
-
-    @property
-    def additional_properties(self) -> dict[str, Any]:
-        """Returns the set of properties that are not None."""
-        return self.model_extra
-
-    @model_validator(mode="before")
-    @classmethod
-    def to_snake_for_all(cls, data):
-        ret = {to_snake(k): v for k, v in data.items()}
-        return ret
-
-    @model_serializer(mode="plain")
-    def to_camel_for_all(self, config):
-        if config.by_alias:
-            new_data = {}
-            for k, v in self:
-                new_data[to_camel(k)] = v
-            return new_data
-        return {k: v for k, v in self}