microsoft-agents-activity 0.0.0__py3-none-any.whl

microsoft/agents/activity/adaptive_card_invoke_response.py

@@ -0,0 +1,20 @@
+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,22 @@
+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.models.AdaptiveCardInvokeAction`
+    :param authentication: The TokenExchangeInvokeRequest for this adaptive card invoke action value.
+    :type authentication: :class:`microsoft.agents.activity.models.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,18 @@
+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}
+    """

microsoft/agents/activity/ai_entity.py

@@ -0,0 +1,142 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+from typing import List, Optional, Union, Literal
+from dataclasses import dataclass
+
+from .agents_model import AgentsModel
+from .activity import Activity
+from .entity import Entity
+
+
+class ClientCitationIconName(str, Enum):
+    """Enumeration of supported citation icon names."""
+
+    MICROSOFT_WORD = "Microsoft Word"
+    MICROSOFT_EXCEL = "Microsoft Excel"
+    MICROSOFT_POWERPOINT = "Microsoft PowerPoint"
+    MICROSOFT_ONENOTE = "Microsoft OneNote"
+    MICROSOFT_SHAREPOINT = "Microsoft SharePoint"
+    MICROSOFT_VISIO = "Microsoft Visio"
+    MICROSOFT_LOOP = "Microsoft Loop"
+    MICROSOFT_WHITEBOARD = "Microsoft Whiteboard"
+    ADOBE_ILLUSTRATOR = "Adobe Illustrator"
+    ADOBE_PHOTOSHOP = "Adobe Photoshop"
+    ADOBE_INDESIGN = "Adobe InDesign"
+    ADOBE_FLASH = "Adobe Flash"
+    SKETCH = "Sketch"
+    SOURCE_CODE = "Source Code"
+    IMAGE = "Image"
+    GIF = "GIF"
+    VIDEO = "Video"
+    SOUND = "Sound"
+    ZIP = "ZIP"
+    TEXT = "Text"
+    PDF = "PDF"
+
+
+class ClientCitationImage(AgentsModel):
+    """Information about the citation's icon."""
+
+    type: str = "ImageObject"
+    name: str = ""
+
+
+class SensitivityPattern(AgentsModel):
+    """Pattern information for sensitivity usage info."""
+
+    type: str = "DefinedTerm"
+    in_defined_term_set: str = ""
+    name: str = ""
+    term_code: str = ""
+
+
+class SensitivityUsageInfo(AgentsModel):
+    """
+    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"
+    description: Optional[str] = None
+    name: str = ""
+    position: Optional[int] = None
+    pattern: Optional[SensitivityPattern] = None
+
+
+class ClientCitationAppearance(AgentsModel):
+    """Appearance information for a client citation."""
+
+    type: str = "DigitalDocument"
+    name: str = ""
+    text: Optional[str] = None
+    url: Optional[str] = None
+    abstract: str = ""
+    encoding_format: Optional[str] = None
+    image: Optional[ClientCitationImage] = None
+    keywords: Optional[List[str]] = None
+    usage_info: Optional[SensitivityUsageInfo] = None
+
+
+class ClientCitation(AgentsModel):
+    """
+    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
+
+    def __post_init__(self):
+        if self.appearance is None:
+            self.appearance = ClientCitationAppearance()
+
+
+class AIEntity(Entity):
+    """Entity indicating AI-generated content."""
+
+    type: str = "https://schema.org/Message"
+    schema_type: str = "Message"
+    context: str = "https://schema.org"
+    id: str = ""
+    additional_type: Optional[List[str]] = None
+    citation: Optional[List[ClientCitation]] = None
+    usage_info: Optional[SensitivityUsageInfo] = None
+
+    def __post_init__(self):
+        if self.additional_type is None:
+            self.additional_type = ["AIGeneratedContent"]
+
+
+def add_ai_to_activity(
+    activity: Activity,
+    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 activity.entities is None:
+            activity.entities = []
+
+        activity.entities.append(ai_entity)

microsoft/agents/activity/animation_card.py

@@ -0,0 +1,54 @@
+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.protocols.models.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]
+    :param buttons: Actions on this card
+    :type buttons: list[~microsoft.agents.protocols.models.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: NonEmptyString = 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,24 @@
+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,21 @@
+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,19 @@
+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.protocols.models.AttachmentView]
+    """
+
+    name: NonEmptyString = None
+    type: NonEmptyString = None
+    views: list[AttachmentView] = None

microsoft/agents/activity/attachment_layout_types.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class AttachmentLayoutTypes(str, Enum):
+    list = "list"
+    carousel = "carousel"

microsoft/agents/activity/attachment_view.py

@@ -0,0 +1,15 @@
+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,54 @@
+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.protocols.models.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]
+    :param buttons: Actions on this card
+    :type buttons: list[~microsoft.agents.protocols.models.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: NonEmptyString = 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,30 @@
+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.protocols.models.CardImage]
+    :param buttons: Set of actions applicable to the current card
+    :type buttons: list[~microsoft.agents.protocols.models.CardAction]
+    :param tap: This action will be activated when user taps on the card
+     itself
+    :type tap: ~microsoft.agents.protocols.models.CardAction
+    """
+
+    title: NonEmptyString = None
+    subtitle: NonEmptyString = None
+    text: NonEmptyString = None
+    images: list[CardImage] = None
+    buttons: list[CardAction] = None
+    tap: CardAction = None

microsoft/agents/activity/caller_id_constants.py

@@ -0,0 +1,7 @@
+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,39 @@
+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.protocols.models.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,19 @@
+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.protocols.models.CardAction
+    """
+
+    url: NonEmptyString = None
+    alt: NonEmptyString = None
+    tap: CardAction = None

microsoft/agents/activity/channel_account.py

@@ -0,0 +1,33 @@
+from typing import Any
+
+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.protocols.models.RoleTypes
+    """
+
+    model_config = ConfigDict(extra="allow")
+
+    id: NonEmptyString
+    name: str = None
+    aad_object_id: NonEmptyString = None
+    role: 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,76 @@
+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