microsoft-agents-activity 0.3.0.dev0__tar.gz → 0.4.0.dev3__tar.gz

{microsoft_agents_activity-0.3.0.dev0 → microsoft_agents_activity-0.4.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-activity
-Version: 0.3.0.dev0
+Version: 0.4.0.dev3
 Summary: A protocol library for Microsoft Agents
 Author: Microsoft Corporation
 Project-URL: Homepage, https://github.com/microsoft/Agents

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/__init__.py

@@ -24,32 +24,32 @@ from .conversation_reference import ConversationReference
 from .conversation_resource_response import ConversationResourceResponse
 from .conversations_result import ConversationsResult
 from .expected_replies import ExpectedReplies
-from .entity import Entity
-from .ai_entity import (
+from .entity import (
+    Entity,
     AIEntity,
     ClientCitation,
     ClientCitationAppearance,
     ClientCitationImage,
     ClientCitationIconName,
+    Mention,
     SensitivityUsageInfo,
     SensitivityPattern,
-    add_ai_to_activity,
+    GeoCoordinates,
+    Place,
+    Thing,
 )
 from .error import Error
 from .error_response import ErrorResponse
 from .fact import Fact
-from .geo_coordinates import GeoCoordinates
 from .hero_card import HeroCard
 from .inner_http_error import InnerHttpError
 from .invoke_response import InvokeResponse
 from .media_card import MediaCard
 from .media_event_value import MediaEventValue
 from .media_url import MediaUrl
-from .mention import Mention
 from .message_reaction import MessageReaction
 from .oauth_card import OAuthCard
 from .paged_members_result import PagedMembersResult
-from .place import Place
 from .receipt_card import ReceiptCard
 from .receipt_item import ReceiptItem
 from .resource_response import ResourceResponse
@@ -57,7 +57,6 @@ from .semantic_action import SemanticAction
 from .signin_card import SigninCard
 from .suggested_actions import SuggestedActions
 from .text_highlight import TextHighlight
-from .thing import Thing
 from .thumbnail_card import ThumbnailCard
 from .thumbnail_url import ThumbnailUrl
 from .token_exchange_invoke_request import TokenExchangeInvokeRequest
@@ -92,7 +91,6 @@ from .caller_id_constants import CallerIdConstants
 from .conversation_update_types import ConversationUpdateTypes
 from .message_update_types import MessageUpdateTypes
 
-
 from .channel_adapter_protocol import ChannelAdapterProtocol
 from .turn_context_protocol import TurnContextProtocol
 from ._load_configuration import load_configuration_from_env
@@ -131,7 +129,6 @@ __all__ = [
     "ClientCitationIconName",
     "SensitivityUsageInfo",
     "SensitivityPattern",
-    "add_ai_to_activity",
     "Error",
     "ErrorResponse",
     "Fact",

microsoft_agents_activity-0.4.0.dev3/microsoft_agents/activity/_model_utils.py

@@ -0,0 +1,61 @@
+from abc import ABC
+from typing import Any, Callable
+
+from .agents_model import AgentsModel
+
+
+class ModelFieldHelper(ABC):
+    """Base class for model field processing prior to initialization of an AgentsModel"""
+
+    def process(self, key: str) -> dict[str, Any]:
+        """Takes the key in the destination object and returns a dictionary of new fields to add"""
+        raise NotImplementedError()
+
+
+class SkipIf(ModelFieldHelper):
+    """Skip if the value meets the given condition."""
+
+    def __init__(self, value, skip_condition: Callable[[Any], bool]):
+        self.value = value
+        self._skip_condition = skip_condition
+
+    def process(self, key: str) -> dict[str, Any]:
+        if self._skip_condition(self.value):
+            return {}
+        return {key: self.value}
+
+
+class SkipNone(SkipIf):
+    """Skip if the value is None."""
+
+    def __init__(self, value):
+        super().__init__(value, lambda v: v is None)
+
+
+def pick_model_dict(**kwargs):
+    """Processes a list of keyword arguments, using ModelFieldHelper subclasses to determine which fields to include in the final model.
+
+    This function is useful for dynamically constructing models based on varying input data.
+
+    Usage:
+        activity_dict = pick_model_dict(type="message", id="123", text=SkipNone(text_variable))
+        activity = Activity.model_validate(activity_dict)
+    """
+
+    model_dict = {}
+    for key, value in kwargs.items():
+        if not isinstance(value, ModelFieldHelper):
+            model_dict[key] = value
+        else:
+            model_dict.update(value.process(key))
+
+    return model_dict
+
+
+def pick_model(model_class: type[AgentsModel], **kwargs) -> AgentsModel:
+    """Picks model fields from the given keyword arguments.
+
+    Usage:
+        activity = pick_model(Activity, type="message", id="123", text=SkipNone(text_variable))
+    """
+    return model_class(**pick_model_dict(**kwargs))

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/activity.py

@@ -5,16 +5,22 @@ from pydantic import Field, SerializeAsAny
 from .activity_types import ActivityTypes
 from .channel_account import ChannelAccount
 from .conversation_account import ConversationAccount
-from .mention import Mention
 from .message_reaction import MessageReaction
 from .resource_response import ResourceResponse
 from .suggested_actions import SuggestedActions
 from .attachment import Attachment
-from .entity import Entity
+from .entity import (
+    Entity,
+    Mention,
+    AIEntity,
+    ClientCitation,
+    SensitivityUsageInfo,
+)
 from .conversation_reference import ConversationReference
 from .text_highlight import TextHighlight
 from .semantic_action import SemanticAction
 from .agents_model import AgentsModel
+from ._model_utils import pick_model, SkipNone
 from ._type_aliases import NonEmptyString
 
 
@@ -27,7 +33,7 @@ class Activity(AgentsModel):
         'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate',
         'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion',
         'trace', 'handoff'
-    :type type: str or ~microsoft.agents.protocols.models.ActivityTypes
+    :type type: str or ~microsoft_agents.activity.ActivityTypes
     :param id: Contains an ID that uniquely identifies the activity on the channel.
     :type id: str
     :param timestamp: Contains the date and time that the message was sent, in UTC, expressed in ISO-8601 format.
@@ -43,23 +49,23 @@ class Activity(AgentsModel):
     :param channel_id: Contains an ID that uniquely identifies the channel. Set by the channel.
     :type channel_id: str
     :param from_property: Identifies the sender of the message.
-    :type from_property: ~microsoft.agents.protocols.models.ChannelAccount
+    :type from_property: ~microsoft_agents.activity.ChannelAccount
     :param conversation: Identifies the conversation to which the activity belongs.
-    :type conversation: ~microsoft.agents.protocols.models.ConversationAccount
+    :type conversation: ~microsoft_agents.activity.ConversationAccount
     :param recipient: Identifies the recipient of the message.
-    :type recipient: ~microsoft.agents.protocols.models.ChannelAccount
+    :type recipient: ~microsoft_agents.activity.ChannelAccount
     :param text_format: Format of text fields Default:markdown. Possible values include: 'markdown', 'plain', 'xml'
-    :type text_format: str or ~microsoft.agents.protocols.models.TextFormatTypes
+    :type text_format: str or ~microsoft_agents.activity.TextFormatTypes
     :param attachment_layout: The layout hint for multiple attachments. Default: list. Possible values include: 'list', 'carousel'
-    :type attachment_layout: str or ~microsoft.agents.protocols.models.AttachmentLayoutTypes
+    :type attachment_layout: str or ~microsoft_agents.activity.AttachmentLayoutTypes
     :param members_added: The collection of members added to the conversation.
-    :type members_added: list[~microsoft.agents.protocols.models.ChannelAccount]
+    :type members_added: list[~microsoft_agents.activity.ChannelAccount]
     :param members_removed: The collection of members removed from the conversation.
-    :type members_removed: list[~microsoft.agents.protocols.models.ChannelAccount]
+    :type members_removed: list[~microsoft_agents.activity.ChannelAccount]
     :param reactions_added: The collection of reactions added to the conversation.
-    :type reactions_added: list[~microsoft.agents.protocols.models.MessageReaction]
+    :type reactions_added: list[~microsoft_agents.activity.MessageReaction]
     :param reactions_removed: The collection of reactions removed from the conversation.
-    :type reactions_removed: list[~microsoft.agents.protocols.models.MessageReaction]
+    :type reactions_removed: list[~microsoft_agents.activity.MessageReaction]
     :param topic_name: The updated topic name of the conversation.
     :type topic_name: str
     :param history_disclosed: Indicates whether the prior history of the channel is disclosed.
@@ -74,15 +80,15 @@ class Activity(AgentsModel):
     :type speak: str
     :param input_hint: Indicates whether your agent is accepting, expecting, or ignoring user input after the message is delivered to the client.
         Possible values include: 'acceptingInput', 'ignoringInput', 'expectingInput'
-    :type input_hint: str or ~microsoft.agents.protocols.models.InputHints
+    :type input_hint: str or ~microsoft_agents.activity.InputHints
     :param summary: The text to display if the channel cannot render cards.
     :type summary: str
     :param suggested_actions: The suggested actions for the activity.
-    :type suggested_actions: ~microsoft.agents.protocols.models.SuggestedActions
+    :type suggested_actions: ~microsoft_agents.activity.SuggestedActions
     :param attachments: Attachments
-    :type attachments: list[~microsoft.agents.protocols.models.Attachment]
+    :type attachments: list[~microsoft_agents.activity.Attachment]
     :param entities: Represents the entities that were mentioned in the message.
-    :type entities: list[~microsoft.agents.protocols.models.Entity]
+    :type entities: list[~microsoft_agents.activity.Entity]
     :param channel_data: Contains channel-specific content.
     :type channel_data: object
     :param action: Indicates whether the recipient of a contactRelationUpdate was added or removed from the sender's contact list.
@@ -98,23 +104,23 @@ class Activity(AgentsModel):
     :param name: The name of the operation associated with an invoke or event activity.
     :type name: str
     :param relates_to: A reference to another conversation or activity.
-    :type relates_to: ~microsoft.agents.protocols.models.ConversationReference
+    :type relates_to: ~microsoft_agents.activity.ConversationReference
     :param code: The a code for endOfConversation activities that indicates why the conversation ended. Possible values include: 'unknown',
         'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
-    :type code: str or ~microsoft.agents.protocols.models.EndOfConversationCodes
+    :type code: str or ~microsoft_agents.activity.EndOfConversationCodes
     :param expiration: The time at which the activity should be considered to be "expired" and should not be presented to the recipient.
     :type expiration: datetime
     :param importance: The importance of the activity. Possible values include: 'low', 'normal', 'high'
-    :type importance: str or ~microsoft.agents.protocols.models.ActivityImportance
+    :type importance: str or ~microsoft_agents.activity.ActivityImportance
     :param delivery_mode: A delivery hint to signal to the recipient alternate delivery paths for the activity.
         The default delivery mode is "default". Possible values include: 'normal', 'notification', 'expectReplies', 'ephemeral'
-    :type delivery_mode: str or ~microsoft.agents.protocols.models.DeliveryModes
+    :type delivery_mode: str or ~microsoft_agents.activity.DeliveryModes
     :param listen_for: List of phrases and references that speech and language priming systems should listen for
     :type listen_for: list[str]
     :param text_highlights: The collection of text fragments to highlight when the activity contains a ReplyToId value.
-    :type text_highlights: list[~microsoft.agents.protocols.models.TextHighlight]
+    :type text_highlights: list[~microsoft_agents.activity.TextHighlight]
     :param semantic_action: An optional programmatic action accompanying this request
-    :type semantic_action: ~microsoft.agents.protocols.models.SemanticAction
+    :type semantic_action: ~microsoft_agents.activity.SemanticAction
     :param caller_id: A string containing an IRI identifying the caller of an agent. This field is not intended to be transmitted over the wire,
         but is instead populated by agents and clients based on cryptographically verifiable data that asserts the identity of the callers (e.g. tokens).
     :type caller_id: str
@@ -390,32 +396,31 @@ class Activity(AgentsModel):
         .. remarks::
             The new activity sets up routing information based on this activity.
         """
-        return Activity(
+        return pick_model(
+            Activity,
             type=ActivityTypes.message,
             timestamp=datetime.now(timezone.utc),
-            from_property=ChannelAccount(
-                id=self.recipient.id if self.recipient else None,
-                name=self.recipient.name if self.recipient else None,
+            from_property=SkipNone(
+                ChannelAccount.pick_properties(self.recipient, ["id", "name"])
             ),
-            recipient=ChannelAccount(
-                id=self.from_property.id if self.from_property else None,
-                name=self.from_property.name if self.from_property else None,
+            recipient=SkipNone(
+                ChannelAccount.pick_properties(self.from_property, ["id", "name"])
             ),
             reply_to_id=(
-                self.id
+                SkipNone(self.id)
                 if type != ActivityTypes.conversation_update
                 or self.channel_id not in ["directline", "webchat"]
                 else None
             ),
             service_url=self.service_url,
             channel_id=self.channel_id,
-            conversation=ConversationAccount(
-                is_group=self.conversation.is_group,
-                id=self.conversation.id,
-                name=self.conversation.name,
+            conversation=SkipNone(
+                ConversationAccount.pick_properties(
+                    self.conversation, ["is_group", "id", "name"]
+                )
             ),
             text=text if text else "",
-            locale=locale if locale else self.locale,
+            locale=locale if locale else SkipNone(self.locale),
             attachments=[],
             entities=[],
         )
@@ -423,6 +428,7 @@ class Activity(AgentsModel):
     def create_trace(
         self, name: str, value: object = None, value_type: str = None, label: str = None
     ):
+        # robrandao: TODO -> needs to handle Nones like create_reply
         """
         Creates a new trace activity based on this activity.
 
@@ -434,42 +440,42 @@ class Activity(AgentsModel):
         :returns: The new trace activity.
         """
         if not value_type and value:
-            value_type = type(value)
+            value_type = type(value).__name__
 
-        return Activity(
+        return pick_model(
+            Activity,
             type=ActivityTypes.trace,
             timestamp=datetime.now(timezone.utc),
-            from_property=ChannelAccount(
-                id=self.recipient.id if self.recipient else None,
-                name=self.recipient.name if self.recipient else None,
+            from_property=SkipNone(
+                ChannelAccount.pick_properties(self.recipient, ["id", "name"])
             ),
-            recipient=ChannelAccount(
-                id=self.from_property.id if self.from_property else None,
-                name=self.from_property.name if self.from_property else None,
+            recipient=SkipNone(
+                ChannelAccount.pick_properties(self.from_property, ["id", "name"])
             ),
             reply_to_id=(
-                self.id
+                SkipNone(self.id)  # preserve unset
                 if type != ActivityTypes.conversation_update
                 or self.channel_id not in ["directline", "webchat"]
                 else None
             ),
             service_url=self.service_url,
             channel_id=self.channel_id,
-            conversation=ConversationAccount(
-                is_group=self.conversation.is_group,
-                id=self.conversation.id,
-                name=self.conversation.name,
+            conversation=SkipNone(
+                ConversationAccount.pick_properties(
+                    self.conversation, ["is_group", "id", "name"]
+                )
             ),
-            name=name,
-            label=label,
-            value_type=value_type,
-            value=value,
+            name=SkipNone(name),
+            label=SkipNone(label),
+            value_type=SkipNone(value_type),
+            value=SkipNone(value),
         ).as_trace_activity()
 
     @staticmethod
     def create_trace_activity(
         name: str, value: object = None, value_type: str = None, label: str = None
     ):
+        # robrandao: TODO -> SkipNone
         """
         Creates an instance of the :class:`Activity` class as a TraceActivity object.
 
@@ -481,14 +487,15 @@ class Activity(AgentsModel):
         :returns: The new trace activity.
         """
         if not value_type and value:
-            value_type = type(value)
+            value_type = type(value).__name__
 
-        return Activity(
+        return pick_model(
+            Activity,
             type=ActivityTypes.trace,
             name=name,
-            label=label,
-            value_type=value_type,
-            value=value,
+            label=SkipNone(label),
+            value_type=SkipNone(value_type),
+            value=SkipNone(value),
         )
 
     @staticmethod
@@ -506,10 +513,10 @@ class Activity(AgentsModel):
 
         :returns: A conversation reference for the conversation that contains this activity.
         """
-
-        return ConversationReference(
+        return pick_model(
+            ConversationReference,
             activity_id=(
-                self.id
+                SkipNone(self.id)
                 if self.type != ActivityTypes.conversation_update
                 or self.channel_id not in ["directline", "webchat"]
                 else None
@@ -532,8 +539,9 @@ class Activity(AgentsModel):
             This method is defined on the :class:`Activity` class, but is only intended for use with a message activity,
             where the activity Activity.Type is set to ActivityTypes.Message.
         """
-        _list = self.entities
-        return [x for x in _list if str(x.type).lower() == "mention"]
+        if not self.entities:
+            return []
+        return [x for x in self.entities if x.type.lower() == "mention"]
 
     def get_reply_conversation_reference(
         self, reply: ResourceResponse
@@ -596,7 +604,7 @@ class Activity(AgentsModel):
         if self.type is None:
             return False
 
-        type_attribute = str(self.type).lower()
+        type_attribute = f"ActivityTypes.{str(self.type)}".lower()
         activity_type = str(activity_type).lower()
 
         result = type_attribute.startswith(activity_type)
@@ -611,3 +619,32 @@ class Activity(AgentsModel):
                 )
 
         return result
+
+    def add_ai_metadata(
+        self,
+        citations: Optional[list[ClientCitation]] = None,
+        usage_info: Optional[SensitivityUsageInfo] = None,
+    ) -> None:
+        """
+        Adds AI entity to an activity to indicate AI-generated content.
+
+        Args:
+            activity: The activity to modify
+            citations: Optional list of citations
+            usage_info: Optional sensitivity usage information
+        """
+        if citations:
+            ai_entity = AIEntity(
+                type="https://schema.org/Message",
+                schema_type="Message",
+                context="https://schema.org",
+                id="",
+                additional_type=["AIGeneratedContent"],
+                citation=citations,
+                usage_info=usage_info,
+            )
+
+            if self.entities is None:
+                self.entities = []
+
+            self.entities.append(ai_entity)

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/adaptive_card_invoke_value.py

@@ -10,9 +10,9 @@ class AdaptiveCardInvokeValue(AgentsModel):
     Defines the structure that arrives in the Activity.Value for Invoke activity with Name of 'adaptiveCard/action'.
 
     :param action: The action of this adaptive card invoke action value.
-    :type action: :class:`microsoft.agents.activity.models.AdaptiveCardInvokeAction`
+    :type action: :class:`microsoft_agents.activity.models.AdaptiveCardInvokeAction`
     :param authentication: The TokenExchangeInvokeRequest for this adaptive card invoke action value.
-    :type authentication: :class:`microsoft.agents.activity.models.TokenExchangeInvokeRequest`
+    :type authentication: :class:`microsoft_agents.activity.models.TokenExchangeInvokeRequest`
     :param state: The 'state' or magic code for an OAuth flow.
     :type state: str
     """

microsoft_agents_activity-0.4.0.dev3/microsoft_agents/activity/agents_model.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+
+class AgentsModel(BaseModel):
+    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+
+    """
+    @model_serializer
+    def _serialize(self):
+        omit_if_empty = {
+            k
+            for k, v in self
+            if isinstance(v, list) and not v
+        }
+
+        return {k: v for k, v in self if k not in omit_if_empty and v is not None}
+    """
+
+    @classmethod
+    def pick_properties(cls, original: AgentsModel, fields_to_copy=None, **kwargs):
+        """Picks properties from the original model and returns a new instance (of a possibly different AgentsModel) with those properties.
+
+        This method preserves unset values.
+
+        args:
+            original: The original model instance to copy properties from. If None, returns None.
+            fields_to_copy: The specific fields to copy. If None, all fields are copied.
+            **kwargs: Additional fields to include in the new instance.
+        """
+        if not original:
+            return None
+
+        if fields_to_copy is None:
+            fields_to_copy = original.model_fields_set
+        else:
+            fields_to_copy = original.model_fields_set & set(fields_to_copy)
+
+        dest = {}
+        for field in fields_to_copy:
+            dest[field] = getattr(original, field)
+
+        dest.update(kwargs)
+        return cls.model_validate(dest)

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/animation_card.py

@@ -15,12 +15,12 @@ class AnimationCard(AgentsModel):
     :param text: Text of this card
     :type text: str
     :param image: Thumbnail placeholder
-    :type image: ~microsoft.agents.protocols.models.ThumbnailUrl
+    :type image: ~microsoft_agents.activity.ThumbnailUrl
     :param media: Media URLs for this card. When this field contains more than
      one URL, each URL is an alternative format of the same content.
-    :type media: list[~microsoft.agents.protocols.models.MediaUrl]
+    :type media: list[~microsoft_agents.activity.MediaUrl]
     :param buttons: Actions on this card
-    :type buttons: list[~microsoft.agents.protocols.models.CardAction]
+    :type buttons: list[~microsoft_agents.activity.CardAction]
     :param shareable: This content may be shared with others (default:true)
     :type shareable: bool
     :param autoloop: Should the client loop playback at end of content
@@ -42,7 +42,7 @@ class AnimationCard(AgentsModel):
 
     title: NonEmptyString = None
     subtitle: NonEmptyString = None
-    text: NonEmptyString = None
+    text: str = None
     image: ThumbnailUrl = None
     media: list[MediaUrl] = None
     buttons: list[CardAction] = None

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/attachment_info.py

@@ -11,7 +11,7 @@ class AttachmentInfo(AgentsModel):
     :param type: ContentType of the attachment
     :type type: str
     :param views: attachment views
-    :type views: list[~microsoft.agents.protocols.models.AttachmentView]
+    :type views: list[~microsoft_agents.activity.AttachmentView]
     """
 
     name: NonEmptyString = None

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/audio_card.py

@@ -15,12 +15,12 @@ class AudioCard(AgentsModel):
     :param text: Text of this card
     :type text: str
     :param image: Thumbnail placeholder
-    :type image: ~microsoft.agents.protocols.models.ThumbnailUrl
+    :type image: ~microsoft_agents.activity.ThumbnailUrl
     :param media: Media URLs for this card. When this field contains more than
      one URL, each URL is an alternative format of the same content.
-    :type media: list[~microsoft.agents.protocols.models.MediaUrl]
+    :type media: list[~microsoft_agents.activity.MediaUrl]
     :param buttons: Actions on this card
-    :type buttons: list[~microsoft.agents.protocols.models.CardAction]
+    :type buttons: list[~microsoft_agents.activity.CardAction]
     :param shareable: This content may be shared with others (default:true)
     :type shareable: bool
     :param autoloop: Should the client loop playback at end of content
@@ -42,7 +42,7 @@ class AudioCard(AgentsModel):
 
     title: NonEmptyString = None
     subtitle: NonEmptyString = None
-    text: NonEmptyString = None
+    text: str = None
     image: ThumbnailUrl = None
     media: list[MediaUrl] = None
     buttons: list[CardAction] = None

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/basic_card.py

@@ -14,17 +14,17 @@ class BasicCard(AgentsModel):
     :param text: Text for the card
     :type text: str
     :param images: Array of images for the card
-    :type images: list[~microsoft.agents.protocols.models.CardImage]
+    :type images: list[~microsoft_agents.activity.CardImage]
     :param buttons: Set of actions applicable to the current card
-    :type buttons: list[~microsoft.agents.protocols.models.CardAction]
+    :type buttons: list[~microsoft_agents.activity.CardAction]
     :param tap: This action will be activated when user taps on the card
      itself
-    :type tap: ~microsoft.agents.protocols.models.CardAction
+    :type tap: ~microsoft_agents.activity.CardAction
     """
 
     title: NonEmptyString = None
     subtitle: NonEmptyString = None
-    text: NonEmptyString = None
+    text: str = None
     images: list[CardImage] = None
     buttons: list[CardAction] = None
     tap: CardAction = None

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/card_action.py

@@ -9,7 +9,7 @@ class CardAction(AgentsModel):
     :param type: The type of action implemented by this button. Possible
      values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo',
      'showImage', 'downloadFile', 'signin', 'call', 'messageBack'
-    :type type: str or ~microsoft.agents.protocols.models.ActionTypes
+    :type type: str or ~microsoft_agents.activity.ActionTypes
     :param title: Text description which appears on the button
     :type title: str
     :param image: Image URL which will appear on the button, next to text

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/card_image.py

@@ -11,7 +11,7 @@ class CardImage(AgentsModel):
     :param alt: Image description intended for screen readers
     :type alt: str
     :param tap: Action assigned to specific Attachment
-    :type tap: ~microsoft.agents.protocols.models.CardAction
+    :type tap: ~microsoft_agents.activity.CardAction
     """
 
     url: NonEmptyString = None

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/channel_account.py

@@ -17,7 +17,7 @@ class ChannelAccount(AgentsModel):
      Directory (AAD)
     :type aad_object_id: str
     :param role: Role of the entity behind the account
-    :type role: str or ~microsoft.agents.protocols.models.RoleTypes
+    :type role: str or ~microsoft_agents.activity.RoleTypes
     """
 
     model_config = ConfigDict(extra="allow")

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/channel_adapter_protocol.py

@@ -2,7 +2,7 @@ from abc import abstractmethod
 from typing import Protocol, List, Callable, Awaitable, Optional
 
 from .turn_context_protocol import TurnContextProtocol
-from microsoft.agents.activity import (
+from microsoft_agents.activity import (
     Activity,
     ResourceResponse,
     ConversationReference,

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/conversation_account.py

@@ -21,7 +21,7 @@ class ConversationAccount(AgentsModel):
      Directory (AAD)
     :type aad_object_id: str
     :param role: Role of the entity behind the account
-    :type role: str or ~microsoft.agents.protocols.models.RoleTypes
+    :type role: str or ~microsoft_agents.activity.RoleTypes
     :param tenant_id: This conversation's tenant ID
     :type tenant_id: str
     :param properties: This conversation's properties

{microsoft_agents_activity-0.3.0.dev0/microsoft/agents → microsoft_agents_activity-0.4.0.dev3/microsoft_agents}/activity/conversation_members.py

@@ -9,7 +9,7 @@ class ConversationMembers(AgentsModel):
     :param id: Conversation ID
     :type id: str
     :param members: List of members in this conversation
-    :type members: list[~microsoft.agents.protocols.models.ChannelAccount]
+    :type members: list[~microsoft_agents.activity.ChannelAccount]
     """
 
     id: NonEmptyString = None