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

microsoft/agents/activity/channels.py

@@ -0,0 +1,158 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+from typing_extensions import Self
+
+
+class Channels(str, Enum):
+    """
+    Ids of channels supported by ABS.
+    """
+
+    console = "console"
+    """Console channel."""
+
+    cortana = "cortana"
+    """Cortana channel."""
+
+    direct_line = "directline"
+    """Direct Line channel."""
+
+    direct_line_speech = "directlinespeech"
+    """Direct Line Speech channel."""
+
+    email = "email"
+    """Email channel."""
+
+    emulator = "emulator"
+    """Emulator channel."""
+
+    facebook = "facebook"
+    """Facebook channel."""
+
+    groupme = "groupme"
+    """Group Me channel."""
+
+    kik = "kik"
+    """Kik channel."""
+
+    line = "line"
+    """Line channel."""
+
+    ms_teams = "msteams"
+    """MS Teams channel."""
+
+    skype = "skype"
+    """Skype channel."""
+
+    skype_for_business = "skypeforbusiness"
+    """Skype for Business channel."""
+
+    slack = "slack"
+    """Slack channel."""
+
+    sms = "sms"
+    """SMS (Twilio) channel."""
+
+    telegram = "telegram"
+    """Telegram channel."""
+
+    test = "test"
+    """Test channel."""
+
+    webchat = "webchat"
+    """WebChat channel."""
+
+    # TODO: validate the need of Self annotations in the following methods
+    @staticmethod
+    def supports_suggested_actions(channel_id: Self, button_cnt: int = 100) -> bool:
+        """Determine if a number of Suggested Actions are supported by a Channel.
+
+        Args:
+            channel_id (str): The Channel to check the if Suggested Actions are supported in.
+            button_cnt (int, optional): Defaults to 100. The number of Suggested Actions to check for the Channel.
+
+        Returns:
+            bool: True if the Channel supports the button_cnt total Suggested Actions, False if the Channel does not
+             support that number of Suggested Actions.
+        """
+
+        max_actions = {
+            # https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies
+            Channels.facebook: 10,
+            Channels.skype: 10,
+            # https://developers.line.biz/en/reference/messaging-api/#items-object
+            Channels.line: 13,
+            # https://dev.kik.com/#/docs/messaging#text-response-object
+            Channels.kik: 20,
+            Channels.telegram: 100,
+            Channels.emulator: 100,
+            Channels.direct_line: 100,
+            Channels.direct_line_speech: 100,
+            Channels.webchat: 100,
+        }
+        return (
+            button_cnt <= max_actions[channel_id]
+            if channel_id in max_actions
+            else False
+        )
+
+    @staticmethod
+    def supports_card_actions(channel_id: Self, button_cnt: int = 100) -> bool:
+        """Determine if a number of Card Actions are supported by a Channel.
+
+        Args:
+            channel_id (str): The Channel to check if the Card Actions are supported in.
+            button_cnt (int, optional): Defaults to 100. The number of Card Actions to check for the Channel.
+
+        Returns:
+            bool: True if the Channel supports the button_cnt total Card Actions, False if the Channel does not support
+             that number of Card Actions.
+        """
+
+        max_actions = {
+            Channels.facebook: 3,
+            Channels.skype: 3,
+            Channels.ms_teams: 3,
+            Channels.line: 99,
+            Channels.slack: 100,
+            Channels.telegram: 100,
+            Channels.emulator: 100,
+            Channels.direct_line: 100,
+            Channels.direct_line_speech: 100,
+            Channels.webchat: 100,
+        }
+        return (
+            button_cnt <= max_actions[channel_id]
+            if channel_id in max_actions
+            else False
+        )
+
+    @staticmethod
+    def has_message_feed(_: str) -> bool:
+        """Determine if a Channel has a Message Feed.
+
+        Args:
+            channel_id (str): The Channel to check for Message Feed.
+
+        Returns:
+            bool: True if the Channel has a Message Feed, False if it does not.
+        """
+
+        return True
+
+    @staticmethod
+    def max_action_title_length(  # pylint: disable=unused-argument
+        channel_id: Self,
+    ) -> int:
+        """Maximum length allowed for Action Titles.
+
+        Args:
+            channel_id (str): The Channel to determine Maximum Action Title Length.
+
+        Returns:
+            int: The total number of characters allowed for an Action Title on a specific Channel.
+        """
+
+        return 20

microsoft/agents/activity/contact_relation_update_action_types.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class ContactRelationUpdateActionTypes(str, Enum):
+    add = "add"
+    remove = "remove"

microsoft/agents/activity/conversation_account.py

@@ -0,0 +1,38 @@
+from typing import Optional
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ConversationAccount(AgentsModel):
+    """Conversation account represents the identity of the conversation within a channel.
+
+    :param is_group: Indicates whether the conversation contains more than two
+     participants at the time the activity was generated
+    :type is_group: bool
+    :param conversation_type: Indicates the type of the conversation in
+     channels that distinguish between conversation types
+    :type conversation_type: str
+    :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
+    :param tenant_id: This conversation's tenant ID
+    :type tenant_id: str
+    :param properties: This conversation's properties
+    :type properties: object
+    """
+
+    is_group: bool = None
+    conversation_type: NonEmptyString = None
+    id: NonEmptyString
+    name: NonEmptyString = None
+    aad_object_id: NonEmptyString = None
+    role: NonEmptyString = None
+    tenant_id: Optional[NonEmptyString] = None
+    properties: object = None

microsoft/agents/activity/conversation_members.py

@@ -0,0 +1,16 @@
+from .channel_account import ChannelAccount
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ConversationMembers(AgentsModel):
+    """Conversation and its members.
+
+    :param id: Conversation ID
+    :type id: str
+    :param members: List of members in this conversation
+    :type members: list[~microsoft.agents.protocols.models.ChannelAccount]
+    """
+
+    id: NonEmptyString = None
+    members: list[ChannelAccount] = None

microsoft/agents/activity/conversation_parameters.py

@@ -0,0 +1,37 @@
+from pydantic import Field
+
+from .channel_account import ChannelAccount
+from .activity import Activity
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ConversationParameters(AgentsModel):
+    """Parameters for creating a new conversation.
+
+    :param is_group: IsGroup
+    :type is_group: bool
+    :param agent: The agent address for this conversation
+    :type agent: ~microsoft.agents.protocols.models.ChannelAccount
+    :param members: Members to add to the conversation
+    :type members: list[~microsoft.agents.protocols.models.ChannelAccount]
+    :param topic_name: (Optional) Topic of the conversation (if supported by
+     the channel)
+    :type topic_name: str
+    :param activity: (Optional) When creating a new conversation, use this
+     activity as the initial message to the conversation
+    :type activity: ~microsoft.agents.protocols.models.Activity
+    :param channel_data: Channel specific payload for creating the
+     conversation
+    :type channel_data: object
+    :param tenant_id: (Optional) The tenant ID in which the conversation should be created
+    :type tenant_id: str
+    """
+
+    is_group: bool = None
+    agent: ChannelAccount = Field(None, alias="bot")
+    members: list[ChannelAccount] = None
+    topic_name: NonEmptyString = None
+    activity: Activity = None
+    channel_data: object = None
+    tenant_id: NonEmptyString = None

microsoft/agents/activity/conversation_reference.py

@@ -0,0 +1,60 @@
+from uuid import uuid4 as uuid
+from typing import Optional
+
+from pydantic import Field
+
+from .channel_account import ChannelAccount
+from .conversation_account import ConversationAccount
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+from .activity_types import ActivityTypes
+from .activity_event_names import ActivityEventNames
+
+
+class ConversationReference(AgentsModel):
+    """An object relating to a particular point in a conversation.
+
+    :param activity_id: (Optional) ID of the activity to refer to
+    :type activity_id: str
+    :param user: (Optional) User participating in this conversation
+    :type user: ~microsoft.agents.protocols.models.ChannelAccount
+    :param agent: Agent participating in this conversation
+    :type agent: ~microsoft.agents.protocols.models.ChannelAccount
+    :param conversation: Conversation reference
+    :type conversation: ~microsoft.agents.protocols.models.ConversationAccount
+    :param channel_id: Channel ID
+    :type channel_id: str
+    :param locale: A locale name for the contents of the text field.
+        The locale name is a combination of an ISO 639 two- or three-letter
+        culture code associated with a language and an ISO 3166 two-letter
+        subculture code associated with a country or region.
+        The locale name can also correspond to a valid BCP-47 language tag.
+    :type locale: str
+    :param service_url: Service endpoint where operations concerning the
+     referenced conversation may be performed
+    :type service_url: str
+    """
+
+    # optionals here are due to webchat
+    activity_id: Optional[NonEmptyString] = None
+    user: Optional[ChannelAccount] = None
+    agent: ChannelAccount = Field(None, alias="bot")
+    conversation: ConversationAccount
+    channel_id: NonEmptyString
+    locale: Optional[NonEmptyString] = None
+    service_url: NonEmptyString
+
+    def get_continuation_activity(self) -> "Activity":  # type: ignore
+        from .activity import Activity
+
+        return Activity(
+            type=ActivityTypes.event,
+            name=ActivityEventNames.continue_conversation,
+            id=str(uuid()),
+            channel_id=self.channel_id,
+            service_url=self.service_url,
+            conversation=self.conversation,
+            recipient=self.agent,
+            from_property=self.user,
+            relates_to=self,
+        )

microsoft/agents/activity/conversation_resource_response.py

@@ -0,0 +1,19 @@
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ConversationResourceResponse(AgentsModel):
+    """A response containing a resource.
+
+    :param activity_id: ID of the Activity (if sent)
+    :type activity_id: str
+    :param service_url: Service endpoint where operations concerning the
+     conversation may be performed
+    :type service_url: str
+    :param id: Id of the resource
+    :type id: str
+    """
+
+    activity_id: NonEmptyString = None
+    service_url: NonEmptyString = None
+    id: NonEmptyString = None

microsoft/agents/activity/conversation_update_types.py

@@ -0,0 +1,15 @@
+from enum import Enum
+
+
+class ConversationUpdateTypes(str, Enum):
+    CHANNEL_CREATED = "channelCreated"
+    CHANNEL_RENAMED = "channelRenamed"
+    CHANNEL_DELETED = "channelDeleted"
+    CHANNEL_RESTORED = "channelRestored"
+    MEMBERS_ADDED = "membersAdded"
+    MEMBERS_REMOVED = "membersRemoved"
+    TEAM_RENAMED = "teamRenamed"
+    TEAM_DELETED = "teamDeleted"
+    TEAM_ARCHIVED = "teamArchived"
+    TEAM_UNARCHIVED = "teamUnarchived"
+    TEAM_RESTORED = "teamRestored"

microsoft/agents/activity/conversations_result.py

@@ -0,0 +1,17 @@
+from .conversation_members import ConversationMembers
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class ConversationsResult(AgentsModel):
+    """Conversations result.
+
+    :param continuation_token: Paging token
+    :type continuation_token: str
+    :param conversations: List of conversations
+    :type conversations:
+     list[~microsoft.agents.protocols.models.ConversationMembers]
+    """
+
+    continuation_token: NonEmptyString = None
+    conversations: list[ConversationMembers] = None

microsoft/agents/activity/delivery_modes.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class DeliveryModes(str, Enum):
+    normal = "normal"
+    notification = "notification"
+    expect_replies = "expectReplies"
+    ephemeral = "ephemeral"
+    stream = "stream"

microsoft/agents/activity/end_of_conversation_codes.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+class EndOfConversationCodes(str, Enum):
+    unknown = "unknown"
+    completed_successfully = "completedSuccessfully"
+    user_cancelled = "userCancelled"
+    timed_out = "botTimedOut"
+    issued_invalid_message = "botIssuedInvalidMessage"
+    channel_failed = "channelFailed"

microsoft/agents/activity/entity.py

@@ -0,0 +1,38 @@
+from typing import Any, Optional
+
+from pydantic import model_serializer, model_validator
+from .agents_model import AgentsModel, ConfigDict
+from pydantic.alias_generators import to_camel, to_snake
+from ._type_aliases import NonEmptyString
+
+
+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: NonEmptyString
+
+    @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}

microsoft/agents/activity/error.py

@@ -0,0 +1,19 @@
+from .inner_http_error import InnerHttpError
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class Error(AgentsModel):
+    """Object representing error information.
+
+    :param code: Error code
+    :type code: str
+    :param message: Error message
+    :type message: str
+    :param inner_http_error: Error from inner http call
+    :type inner_http_error: ~microsoft.agents.protocols.models.InnerHttpError
+    """
+
+    code: NonEmptyString = None
+    message: NonEmptyString = None
+    inner_http_error: InnerHttpError = None

microsoft/agents/activity/error_response.py

@@ -0,0 +1,12 @@
+from .agents_model import AgentsModel
+from .error import Error
+
+
+class ErrorResponse(AgentsModel):
+    """An HTTP API response.
+
+    :param error: Error message
+    :type error: ~microsoft.agents.protocols.models.Error
+    """
+
+    error: Error = None

microsoft/agents/activity/expected_replies.py

@@ -0,0 +1,13 @@
+from .activity import Activity
+from .agents_model import AgentsModel
+
+
+class ExpectedReplies(AgentsModel):
+    """ExpectedReplies.
+
+    :param activities: A collection of Activities that conforms to the
+     ExpectedReplies schema.
+    :type activities: list[~microsoft.agents.protocols.models.Activity]
+    """
+
+    activities: list[Activity] = None

microsoft/agents/activity/fact.py

@@ -0,0 +1,18 @@
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class Fact(AgentsModel):
+    """Set of key-value pairs. Advantage of this section is that key and value
+    properties will be
+    rendered with default style information with some delimiter between them.
+    So there is no need for developer to specify style information.
+
+    :param key: The key for this Fact
+    :type key: str
+    :param value: The value for this Fact
+    :type value: str
+    """
+
+    key: NonEmptyString = None
+    value: NonEmptyString = None

microsoft/agents/activity/geo_coordinates.py

@@ -0,0 +1,27 @@
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class GeoCoordinates(AgentsModel):
+    """GeoCoordinates (entity type: "https://schema.org/GeoCoordinates").
+
+    :param elevation: Elevation of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type elevation: float
+    :param latitude: Latitude of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type latitude: float
+    :param longitude: Longitude of the location [WGS
+     84](https://en.wikipedia.org/wiki/World_Geodetic_System)
+    :type longitude: float
+    :param type: The type of the thing
+    :type type: str
+    :param name: The name of the thing
+    :type name: str
+    """
+
+    elevation: float = None
+    latitude: float = None
+    longitude: float = None
+    type: NonEmptyString = None
+    name: NonEmptyString = None

microsoft/agents/activity/hero_card.py

@@ -0,0 +1,30 @@
+from .card_action import CardAction
+from .card_image import CardImage
+from .agents_model import AgentsModel
+from ._type_aliases import NonEmptyString
+
+
+class HeroCard(AgentsModel):
+    """A Hero card (card with a single, large image).
+
+    :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/inner_http_error.py

@@ -0,0 +1,14 @@
+from .agents_model import AgentsModel
+
+
+class InnerHttpError(AgentsModel):
+    """Object representing inner http error.
+
+    :param status_code: HttpStatusCode from failed request
+    :type status_code: int
+    :param body: Body from failed request
+    :type body: object
+    """
+
+    status_code: int = None
+    body: object = None

microsoft/agents/activity/input_hints.py

@@ -0,0 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class InputHints(str, Enum):
+    accepting_input = "acceptingInput"
+    ignoring_input = "ignoringInput"
+    expecting_input = "expectingInput"

microsoft/agents/activity/installation_update_action_types.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class InstallationUpdateActionTypes(str, Enum):
+    add = "add"
+    remove = "remove"

microsoft/agents/activity/invoke_response.py

@@ -0,0 +1,24 @@
+from .agents_model import AgentsModel
+
+
+class InvokeResponse(AgentsModel):
+    """
+    Tuple class containing an HTTP Status Code and a JSON serializable
+    object. The HTTP Status code is, in the invoke activity scenario, what will
+    be set in the resulting POST. The Body of the resulting POST will be
+    JSON serialized content.
+
+    The body content is defined by the producer.  The caller must know what
+    the content is and deserialize as needed.
+    """
+
+    status: int = None
+    body: object = None
+
+    def is_successful_status_code(self) -> bool:
+        """
+        Gets a value indicating whether the invoke response was successful.
+        :return: A value that indicates if the HTTP response was successful. true if status is in
+        the Successful range (200-299); otherwise false.
+        """
+        return 200 <= self.status <= 299

microsoft/agents/activity/media_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 MediaCard(AgentsModel):
+    """Media 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