microsoft-agents-activity 0.7.0.dev0__py3-none-any.whl

microsoft_agents/activity/activity_event_names.py

@@ -0,0 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class ActivityEventNames(str, Enum):
+    continue_conversation = "ContinueConversation"
+    create_conversation = "CreateConversation"

microsoft_agents/activity/activity_importance.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class ActivityImportance(str, Enum):
+    low = "low"
+    normal = "normal"
+    high = "high"

microsoft_agents/activity/activity_types.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class ActivityTypes(str, Enum):
+    message = "message"
+    contact_relation_update = "contactRelationUpdate"
+    conversation_update = "conversationUpdate"
+    typing = "typing"
+    end_of_conversation = "endOfConversation"
+    event = "event"
+    invoke = "invoke"
+    invoke_response = "invokeResponse"
+    delete_user_data = "deleteUserData"
+    message_update = "messageUpdate"
+    message_delete = "messageDelete"
+    installation_update = "installationUpdate"
+    message_reaction = "messageReaction"
+    suggestion = "suggestion"
+    trace = "trace"
+    handoff = "handoff"
+    command = "command"
+    command_result = "commandResult"

microsoft_agents/activity/adaptive_card_invoke_action.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AdaptiveCardInvokeAction(AgentsModel):
+    """AdaptiveCardInvokeAction.
+
+    Defines the structure that arrives in the Activity.Value.Action for Invoke activity with
+    name of 'adaptiveCard/action'.
+
+    :param type: The Type of this Adaptive Card Invoke Action.
+    :type type: str
+    :param id: The Id of this Adaptive Card Invoke Action.
+    :type id: str
+    :param verb: The Verb of this Adaptive Card Invoke Action.
+    :type verb: str
+    :param data: The data of this Adaptive Card Invoke Action.
+    :type data: dict[str, object]
+    """
+
+    type: NonEmptyString = None
+    id: NonEmptyString = None
+    verb: NonEmptyString = None
+    data: dict[NonEmptyString, object] = None

microsoft_agents/activity/adaptive_card_invoke_response.py

@@ -0,0 +1,23 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AdaptiveCardInvokeResponse(AgentsModel):
+    """AdaptiveCardInvokeResponse.
+
+    Defines the structure that is returned as the result of an Invoke activity with Name of 'adaptiveCard/action'.
+
+    :param status_code: The Card Action Response StatusCode.
+    :type status_code: int
+    :param type: The type of this Card Action Response.
+    :type type: str
+    :param value: The JSON response object.
+    :type value: dict[str, object]
+    """
+
+    status_code: int = None
+    type: NonEmptyString = None
+    value: dict[NonEmptyString, object] = None

microsoft_agents/activity/adaptive_card_invoke_value.py

@@ -0,0 +1,25 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .adaptive_card_invoke_action import AdaptiveCardInvokeAction
+from .token_exchange_invoke_request import TokenExchangeInvokeRequest
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AdaptiveCardInvokeValue(AgentsModel):
+    """AdaptiveCardInvokeResponse.
+
+    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.adaptive_card_invoke_action.AdaptiveCardInvokeAction`
+    :param authentication: The TokenExchangeInvokeRequest for this adaptive card invoke action value.
+    :type authentication: :class:`microsoft_agents.activity.token_exchange_invoke_request.TokenExchangeInvokeRequest`
+    :param state: The 'state' or magic code for an OAuth flow.
+    :type state: str
+    """
+
+    action: AdaptiveCardInvokeAction = None
+    authentication: TokenExchangeInvokeRequest = None
+    state: NonEmptyString = None

microsoft_agents/activity/agents_model.py

@@ -0,0 +1,49 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+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/animation_card.py

@@ -0,0 +1,57 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .thumbnail_url import ThumbnailUrl
+from .media_url import MediaUrl
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AnimationCard(AgentsModel):
+    """An animation card (Ex: gif or short video clip).
+
+    :param title: Title of this card
+    :type title: str
+    :param subtitle: Subtitle of this card
+    :type subtitle: str
+    :param text: Text of this card
+    :type text: str
+    :param image: Thumbnail placeholder
+    :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.activity.MediaUrl]
+    :param buttons: Actions on this card
+    :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
+     (default:true)
+    :type autoloop: bool
+    :param autostart: Should the client automatically start playback of media
+     in this card (default:true)
+    :type autostart: bool
+    :param aspect: Aspect ratio of thumbnail/media placeholder. Allowed values
+     are "16:9" and "4:3"
+    :type aspect: str
+    :param duration: Describes the length of the media content without
+     requiring a receiver to open the content. Formatted as an ISO 8601
+     Duration field.
+    :type duration: str
+    :param value: Supplementary parameter for this card
+    :type value: object
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    image: ThumbnailUrl = None
+    media: list[MediaUrl] = None
+    buttons: list[CardAction] = None
+    shareable: bool = None
+    autoloop: bool = None
+    autostart: bool = None
+    aspect: NonEmptyString = None
+    duration: NonEmptyString = None
+    value: object = None

microsoft_agents/activity/attachment.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class Attachment(AgentsModel):
+    """An attachment within an activity.
+
+    :param content_type: mimetype/Contenttype for the file
+    :type content_type: str
+    :param content_url: Content Url
+    :type content_url: str
+    :param content: Embedded content
+    :type content: object
+    :param name: (OPTIONAL) The name of the attachment
+    :type name: str
+    :param thumbnail_url: (OPTIONAL) Thumbnail associated with attachment
+    :type thumbnail_url: str
+    """
+
+    content_type: NonEmptyString
+    content_url: NonEmptyString = None
+    content: object = None
+    name: NonEmptyString = None
+    thumbnail_url: NonEmptyString = None

microsoft_agents/activity/attachment_data.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AttachmentData(AgentsModel):
+    """Attachment data.
+
+    :param type: Content-Type of the attachment
+    :type type: str
+    :param name: Name of the attachment
+    :type name: str
+    :param original_base64: Attachment content
+    :type original_base64: bytes
+    :param thumbnail_base64: Attachment thumbnail
+    :type thumbnail_base64: bytes
+    """
+
+    type: NonEmptyString = None
+    name: NonEmptyString = None
+    original_base64: bytes = None
+    thumbnail_base64: bytes = None

microsoft_agents/activity/attachment_info.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .attachment_view import AttachmentView
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AttachmentInfo(AgentsModel):
+    """Metadata for an attachment.
+
+    :param name: Name of the attachment
+    :type name: str
+    :param type: ContentType of the attachment
+    :type type: str
+    :param views: attachment views
+    :type views: list[~microsoft_agents.activity.AttachmentView]
+    """
+
+    name: NonEmptyString = None
+    type: NonEmptyString = None
+    views: list[AttachmentView] = None

microsoft_agents/activity/attachment_layout_types.py

@@ -0,0 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class AttachmentLayoutTypes(str, Enum):
+    list = "list"
+    carousel = "carousel"

microsoft_agents/activity/attachment_view.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class AttachmentView(AgentsModel):
+    """Attachment View name and size.
+
+    :param view_id: Id of the attachment
+    :type view_id: str
+    :param size: Size of the attachment
+    :type size: int
+    """
+
+    view_id: NonEmptyString = None
+    size: int = None

microsoft_agents/activity/audio_card.py

@@ -0,0 +1,57 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .thumbnail_url import ThumbnailUrl
+from .media_url import MediaUrl
+from .card_action import CardAction
+from ._type_aliases import NonEmptyString
+
+
+class AudioCard(AgentsModel):
+    """Audio card.
+
+    :param title: Title of this card
+    :type title: str
+    :param subtitle: Subtitle of this card
+    :type subtitle: str
+    :param text: Text of this card
+    :type text: str
+    :param image: Thumbnail placeholder
+    :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.activity.MediaUrl]
+    :param buttons: Actions on this card
+    :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
+     (default:true)
+    :type autoloop: bool
+    :param autostart: Should the client automatically start playback of media
+     in this card (default:true)
+    :type autostart: bool
+    :param aspect: Aspect ratio of thumbnail/media placeholder. Allowed values
+     are "16:9" and "4:3"
+    :type aspect: str
+    :param duration: Describes the length of the media content without
+     requiring a receiver to open the content. Formatted as an ISO 8601
+     Duration field.
+    :type duration: str
+    :param value: Supplementary parameter for this card
+    :type value: object
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    image: ThumbnailUrl = None
+    media: list[MediaUrl] = None
+    buttons: list[CardAction] = None
+    shareable: bool = None
+    autoloop: bool = None
+    autostart: bool = None
+    aspect: NonEmptyString = None
+    duration: NonEmptyString = None
+    value: object = None

microsoft_agents/activity/basic_card.py

@@ -0,0 +1,33 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .card_image import CardImage
+from .card_action import CardAction
+from ._type_aliases import NonEmptyString
+
+
+class BasicCard(AgentsModel):
+    """A basic card.
+
+    :param title: Title of the card
+    :type title: str
+    :param subtitle: Subtitle of the card
+    :type subtitle: str
+    :param text: Text for the card
+    :type text: str
+    :param images: Array of images for the card
+    :type images: list[~microsoft_agents.activity.CardImage]
+    :param buttons: Set of actions applicable to the current card
+    :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.activity.CardAction
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: str = None
+    images: list[CardImage] = None
+    buttons: list[CardAction] = None
+    tap: CardAction = None

microsoft_agents/activity/caller_id_constants.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class CallerIdConstants(str, Enum):
+    public_azure_channel = "urn:botframework:azure"
+    us_gov_channel = "urn:botframework:azureusgov"
+    agent_to_agent_prefix = "urn:botframework:aadappid:"

microsoft_agents/activity/card_action.py

@@ -0,0 +1,42 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Optional
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class CardAction(AgentsModel):
+    """A clickable action.
+
+    :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.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
+     label
+    :type image: str
+    :param text: Text for this action
+    :type text: str
+    :param display_text: (Optional) text to display in the chat feed if the
+     button is clicked
+    :type display_text: str
+    :param value: Supplementary parameter for action. Content of this property
+     depends on the ActionType
+    :type value: object
+    :param channel_data: Channel-specific data associated with this action
+    :type channel_data: object
+    :param image_alt_text: Alternate image text to be used in place of the `image` field
+    :type image_alt_text: str
+    """
+
+    type: NonEmptyString
+    title: NonEmptyString
+    image: str = None
+    text: str = None
+    display_text: str = None
+    value: object = None
+    channel_data: Optional[object] = None
+    image_alt_text: str = None

microsoft_agents/activity/card_image.py

@@ -0,0 +1,22 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .card_action import CardAction
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class CardImage(AgentsModel):
+    """An image on a card.
+
+    :param url: URL thumbnail image for major content property
+    :type url: str
+    :param alt: Image description intended for screen readers
+    :type alt: str
+    :param tap: Action assigned to specific Attachment
+    :type tap: ~microsoft_agents.activity.CardAction
+    """
+
+    url: NonEmptyString = None
+    alt: NonEmptyString = None
+    tap: CardAction = None

microsoft_agents/activity/channel_account.py

@@ -0,0 +1,39 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any, Optional
+
+from pydantic import ConfigDict
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ChannelAccount(AgentsModel):
+    """Channel account information needed to route a message.
+
+    :param id: Channel id for the user or agent on this channel (Example:
+     ``joe@smith.com``, or ``@joesmith`` or ``123456``)
+    :type id: str
+    :param name: Display friendly name
+    :type name: str
+    :param aad_object_id: This account's object ID within Azure Active
+     Directory (AAD)
+    :type aad_object_id: str
+    :param role: Role of the entity behind the account
+    :type role: str or ~microsoft_agents.activity.RoleTypes
+    """
+
+    model_config = ConfigDict(extra="allow")
+
+    id: NonEmptyString = None
+    name: str = None
+    aad_object_id: Optional[NonEmptyString] = None
+    role: Optional[NonEmptyString] = None
+    agentic_user_id: Optional[NonEmptyString] = None
+    agentic_app_id: Optional[NonEmptyString] = None
+    tenant_id: Optional[NonEmptyString] = None
+
+    @property
+    def properties(self) -> dict[str, Any]:
+        """Returns the set of properties that are not None."""
+        return self.model_extra

microsoft_agents/activity/channel_adapter_protocol.py

@@ -0,0 +1,79 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from abc import abstractmethod
+from typing import Protocol, List, Callable, Awaitable, Optional
+
+from .turn_context_protocol import TurnContextProtocol
+from microsoft_agents.activity import (
+    Activity,
+    ResourceResponse,
+    ConversationReference,
+    ConversationParameters,
+)
+
+
+class ChannelAdapterProtocol(Protocol):
+    on_turn_error: Optional[Callable[[TurnContextProtocol, Exception], Awaitable]]
+
+    @abstractmethod
+    async def send_activities(
+        self, context: TurnContextProtocol, activities: List[Activity]
+    ) -> List[ResourceResponse]:
+        pass
+
+    @abstractmethod
+    async def update_activity(
+        self, context: TurnContextProtocol, activity: Activity
+    ) -> None:
+        pass
+
+    @abstractmethod
+    async def delete_activity(
+        self, context: TurnContextProtocol, reference: ConversationReference
+    ) -> None:
+        pass
+
+    @abstractmethod
+    def use(self, middleware: object) -> "ChannelAdapterProtocol":
+        pass
+
+    @abstractmethod
+    async def continue_conversation(
+        self,
+        agent_id: str,
+        reference: ConversationReference,
+        callback: Callable[[TurnContextProtocol], Awaitable],
+    ) -> None:
+        pass
+
+    # TODO: potentially move ClaimsIdentity to activity
+    @abstractmethod
+    async def continue_conversation_with_claims(
+        self,
+        claims_identity: dict,
+        continuation_activity: Activity,
+        callback: Callable[[TurnContextProtocol], Awaitable],
+        audience: str = None,
+    ):
+        pass
+
+    @abstractmethod
+    async def create_conversation(
+        self,
+        agent_app_id: str,
+        channel_id: str,
+        service_url: str,
+        audience: str,
+        conversation_parameters: ConversationParameters,
+        callback: Callable[[TurnContextProtocol], Awaitable],
+    ) -> None:
+        pass
+
+    @abstractmethod
+    async def run_pipeline(
+        self,
+        context: TurnContextProtocol,
+        callback: Callable[[TurnContextProtocol], Awaitable],
+    ) -> None:
+        pass