microsoft-agents-activity 0.4.0.dev16__py3-none-any.whl → 0.5.0__py3-none-any.whl

microsoft_agents/activity/channels.py

@@ -74,7 +74,7 @@ class Channels(str, Enum):
 
         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.
+            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
@@ -107,7 +107,7 @@ class Channels(str, Enum):
 
         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.
+            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

microsoft_agents/activity/contact_relation_update_action_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/conversation_account.py

@@ -1,3 +1,6 @@
+# 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

microsoft_agents/activity/conversation_members.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .channel_account import ChannelAccount
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString

microsoft_agents/activity/conversation_parameters.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from pydantic import Field
 
 from .channel_account import ChannelAccount

microsoft_agents/activity/conversation_reference.py

@@ -1,17 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from __future__ import annotations
+
 from uuid import uuid4 as uuid
 from typing import Optional
+import logging
 
 from pydantic import Field
 
 from .channel_account import ChannelAccount
+from ._channel_id_field_mixin import _ChannelIdFieldMixin
+from .channel_id import ChannelId
 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
 
+logger = logging.getLogger(__name__)
+
 
-class ConversationReference(AgentsModel):
+class ConversationReference(AgentsModel, _ChannelIdFieldMixin):
     """An object relating to a particular point in a conversation.
 
     :param activity_id: (Optional) ID of the activity to refer to
@@ -23,7 +33,7 @@ class ConversationReference(AgentsModel):
     :param conversation: Conversation reference
     :type conversation: ~microsoft_agents.activity.ConversationAccount
     :param channel_id: Channel ID
-    :type channel_id: str
+    :type channel_id: ~microsoft_agents.activity.ChannelId
     :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
@@ -40,7 +50,6 @@ class ConversationReference(AgentsModel):
     user: Optional[ChannelAccount] = None
     agent: ChannelAccount = Field(None, alias="bot")
     conversation: ConversationAccount
-    channel_id: NonEmptyString
     locale: Optional[NonEmptyString] = None
     service_url: NonEmptyString = None
 

microsoft_agents/activity/conversation_resource_response.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/conversation_update_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/conversations_result.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .conversation_members import ConversationMembers
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString

microsoft_agents/activity/delivery_modes.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/end_of_conversation_codes.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/entity/__init__.py

@@ -1,5 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .mention import Mention
 from .entity import Entity
+from .entity_types import EntityTypes
 from .ai_entity import (
     ClientCitation,
     ClientCitationAppearance,
@@ -11,10 +15,12 @@ from .ai_entity import (
 )
 from .geo_coordinates import GeoCoordinates
 from .place import Place
+from .product_info import ProductInfo
 from .thing import Thing
 
 __all__ = [
     "Entity",
+    "EntityTypes",
     "AIEntity",
     "ClientCitation",
     "ClientCitationAppearance",
@@ -25,5 +31,6 @@ __all__ = [
     "SensitivityPattern",
     "GeoCoordinates",
     "Place",
+    "ProductInfo",
     "Thing",
 ]

microsoft_agents/activity/entity/entity.py

@@ -1,11 +1,12 @@
-from typing import Any, Optional
-from enum import Enum
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Any
 
 from pydantic import model_serializer, model_validator
 from pydantic.alias_generators import to_camel, to_snake
 
 from ..agents_model import AgentsModel, ConfigDict
-from .._type_aliases import NonEmptyString
 
 
 class Entity(AgentsModel):

microsoft_agents/activity/entity/entity_types.py

@@ -0,0 +1,14 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class EntityTypes(str, Enum):
+    """Well-known enumeration of entity types."""
+
+    GEO_COORDINATES = "GeoCoordinates"
+    MENTION = "mention"
+    PLACE = "Place"
+    THING = "Thing"
+    PRODUCT_INFO = "ProductInfo"

microsoft_agents/activity/entity/geo_coordinates.py

@@ -1,8 +1,14 @@
-from ..agents_model import AgentsModel
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
 from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
 
 
-class GeoCoordinates(AgentsModel):
+class GeoCoordinates(Entity):
     """GeoCoordinates (entity type: "https://schema.org/GeoCoordinates").
 
     :param elevation: Elevation of the location [WGS
@@ -23,5 +29,5 @@ class GeoCoordinates(AgentsModel):
     elevation: float = None
     latitude: float = None
     longitude: float = None
-    type: NonEmptyString = None
+    type: Literal[EntityTypes.GEO_COORDINATES] = EntityTypes.GEO_COORDINATES
     name: NonEmptyString = None

microsoft_agents/activity/entity/mention.py

@@ -1,8 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Literal
 
 from ..channel_account import ChannelAccount
 from .entity import Entity
-from .._type_aliases import NonEmptyString
+from .entity_types import EntityTypes
 
 
 class Mention(Entity):
@@ -18,4 +21,4 @@ class Mention(Entity):
 
     mentioned: ChannelAccount = None
     text: str = None
-    type: Literal["mention"] = "mention"
+    type: Literal[EntityTypes.MENTION] = EntityTypes.MENTION

microsoft_agents/activity/entity/place.py

@@ -1,8 +1,14 @@
-from ..agents_model import AgentsModel
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
 from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
 
 
-class Place(AgentsModel):
+class Place(Entity):
     """Place (entity type: "https://schema.org/Place").
 
     :param address: Address of the place (may be `string` or complex object of
@@ -23,5 +29,5 @@ class Place(AgentsModel):
     address: object = None
     geo: object = None
     has_map: object = None
-    type: NonEmptyString = None
+    type: Literal[EntityTypes.PLACE] = EntityTypes.PLACE
     name: NonEmptyString = None

microsoft_agents/activity/entity/product_info.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
+from .entity import Entity
+from .entity_types import EntityTypes
+
+
+class ProductInfo(Entity):
+    """Product information (entity type: "productInfo").
+
+    :param type: The type of the entity, always "productInfo".
+    :type type: str
+    :param id: The unique identifier for the product.
+    :type id: str
+    """
+
+    type: Literal[EntityTypes.PRODUCT_INFO] = EntityTypes.PRODUCT_INFO
+    id: str = None

microsoft_agents/activity/entity/thing.py

@@ -1,8 +1,14 @@
-from ..agents_model import AgentsModel
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import Literal
+
 from .._type_aliases import NonEmptyString
+from .entity import Entity
+from .entity_types import EntityTypes
 
 
-class Thing(AgentsModel):
+class Thing(Entity):
     """Thing (entity type: "https://schema.org/Thing").
 
     :param type: The type of the thing
@@ -11,5 +17,5 @@ class Thing(AgentsModel):
     :type name: str
     """
 
-    type: NonEmptyString = None
+    type: Literal[EntityTypes.THING] = EntityTypes.THING
     name: NonEmptyString = None

microsoft_agents/activity/error.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .inner_http_error import InnerHttpError
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString

microsoft_agents/activity/error_response.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from .error import Error
 

microsoft_agents/activity/expected_replies.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .activity import Activity
 from .agents_model import AgentsModel
 

microsoft_agents/activity/fact.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/hero_card.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .card_action import CardAction
 from .card_image import CardImage
 from .agents_model import AgentsModel

microsoft_agents/activity/inner_http_error.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 
 

microsoft_agents/activity/installation_update_action_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/invoke_response.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 
 

microsoft_agents/activity/media_card.py

@@ -1,3 +1,6 @@
+# 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

microsoft_agents/activity/media_event_value.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 
 

microsoft_agents/activity/media_url.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/message_reaction.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/message_reaction_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/message_update_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/oauth_card.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from typing import Optional
 from .card_action import CardAction
 from .agents_model import AgentsModel

microsoft_agents/activity/paged_members_result.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .channel_account import ChannelAccount
 from ._type_aliases import NonEmptyString
 from .agents_model import AgentsModel

microsoft_agents/activity/receipt_card.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .fact import Fact
 from .receipt_item import ReceiptItem
 from .card_action import CardAction

microsoft_agents/activity/receipt_item.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .card_image import CardImage
 from .card_action import CardAction
 from .agents_model import AgentsModel

microsoft_agents/activity/resource_response.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/role_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/semantic_action.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 
@@ -10,7 +13,7 @@ class SemanticAction(AgentsModel):
     :param entities: Entities associated with this action
     :type entities: dict[str, :class:`microsoft_agents.activity.entity.Entity`]
     :param state: State of this action. Allowed values: `start`, `continue`, `done`
-    :type state: str or :class:`microsoft_agents.activity.semantic_action_states.SemanticActionStates`
+    :type state: str or :class:`microsoft_agents.activity.semantic_actions_states.SemanticActionsStates`
     """
 
     id: NonEmptyString

microsoft_agents/activity/semantic_actions_states.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/sign_in_resource.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from ._type_aliases import NonEmptyString
 from .agents_model import AgentsModel
 from .token_exchange_resource import TokenExchangeResource

microsoft_agents/activity/signin_card.py

@@ -1,3 +1,6 @@
+# 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

microsoft_agents/activity/suggested_actions.py

@@ -1,3 +1,6 @@
+# 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

microsoft_agents/activity/text_format_types.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from enum import Enum
 
 

microsoft_agents/activity/text_highlight.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/thumbnail_card.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .card_image import CardImage
 from .card_action import CardAction
 from .agents_model import AgentsModel

microsoft_agents/activity/thumbnail_url.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/token_exchange_invoke_request.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/token_exchange_invoke_response.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/token_exchange_resource.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 
 from ._type_aliases import NonEmptyString

microsoft_agents/activity/token_exchange_state.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 import base64
 import json
 from typing import Optional

microsoft_agents/activity/token_or_sign_in_resource_response.py

@@ -0,0 +1,21 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from .agents_model import AgentsModel
+from .token_response import TokenResponse
+from .sign_in_resource import SignInResource
+
+
+class TokenOrSignInResourceResponse(AgentsModel):
+    """Represents the response containing either a token or a sign-in resource.
+
+    One of the two properties should be set (if returned from the 'getTokenOrSignInResource' endpoint), not both.
+
+    :param token_response: The token response.
+    :type token_response: TokenResponse
+    :param sign_in_resource: The sign-in resource.
+    :type sign_in_resource: SignInResource
+    """
+
+    token_response: TokenResponse = None
+    sign_in_resource: SignInResource = None

microsoft_agents/activity/token_post_resource.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 
 from ._type_aliases import NonEmptyString

microsoft_agents/activity/token_request.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 

microsoft_agents/activity/transcript.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from .activity import Activity
 from .agents_model import AgentsModel
 

microsoft_agents/activity/turn_context_protocol.py

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 from __future__ import annotations
 
 from typing import Protocol, List, Callable, Optional, Generic, TypeVar