microsoft-agents-activity 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

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/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

microsoft_agents/activity/conversation_parameters.py

@@ -12,15 +12,15 @@ class ConversationParameters(AgentsModel):
     :param is_group: IsGroup
     :type is_group: bool
     :param agent: The agent address for this conversation
-    :type agent: ~microsoft_agents.protocols.models.ChannelAccount
+    :type agent: ~microsoft_agents.activity.ChannelAccount
     :param members: Members to add to the conversation
-    :type members: list[~microsoft_agents.protocols.models.ChannelAccount]
+    :type members: list[~microsoft_agents.activity.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
+    :type activity: ~microsoft_agents.activity.Activity
     :param channel_data: Channel specific payload for creating the
      conversation
     :type channel_data: object

microsoft_agents/activity/conversation_reference.py

@@ -17,11 +17,11 @@ class ConversationReference(AgentsModel):
     :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
+    :type user: ~microsoft_agents.activity.ChannelAccount
     :param agent: Agent participating in this conversation
-    :type agent: ~microsoft_agents.protocols.models.ChannelAccount
+    :type agent: ~microsoft_agents.activity.ChannelAccount
     :param conversation: Conversation reference
-    :type conversation: ~microsoft_agents.protocols.models.ConversationAccount
+    :type conversation: ~microsoft_agents.activity.ConversationAccount
     :param channel_id: Channel ID
     :type channel_id: str
     :param locale: A locale name for the contents of the text field.

microsoft_agents/activity/conversations_result.py

@@ -10,7 +10,7 @@ class ConversationsResult(AgentsModel):
     :type continuation_token: str
     :param conversations: List of conversations
     :type conversations:
-     list[~microsoft_agents.protocols.models.ConversationMembers]
+     list[~microsoft_agents.activity.ConversationMembers]
     """
 
     continuation_token: NonEmptyString = None

microsoft_agents/activity/entity/__init__.py

@@ -0,0 +1,29 @@
+from .mention import Mention
+from .entity import Entity
+from .ai_entity import (
+    ClientCitation,
+    ClientCitationAppearance,
+    ClientCitationImage,
+    ClientCitationIconName,
+    AIEntity,
+    SensitivityPattern,
+    SensitivityUsageInfo,
+)
+from .geo_coordinates import GeoCoordinates
+from .place import Place
+from .thing import Thing
+
+__all__ = [
+    "Entity",
+    "AIEntity",
+    "ClientCitation",
+    "ClientCitationAppearance",
+    "ClientCitationImage",
+    "ClientCitationIconName",
+    "Mention",
+    "SensitivityUsageInfo",
+    "SensitivityPattern",
+    "GeoCoordinates",
+    "Place",
+    "Thing",
+]

microsoft_agents/activity/{ai_entity.py → entity/ai_entity.py}

@@ -5,8 +5,7 @@ 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 ..agents_model import AgentsModel
 from .entity import Entity
 
 
@@ -110,33 +109,3 @@ class AIEntity(Entity):
     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/{entity.py → entity/entity.py}

@@ -1,9 +1,11 @@
 from typing import Any, Optional
+from enum import Enum
 
 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
+
+from ..agents_model import AgentsModel, ConfigDict
+from .._type_aliases import NonEmptyString
 
 
 class Entity(AgentsModel):
@@ -15,7 +17,7 @@ class Entity(AgentsModel):
 
     model_config = ConfigDict(extra="allow")
 
-    type: NonEmptyString
+    type: str
 
     @property
     def additional_properties(self) -> dict[str, Any]:

microsoft_agents/activity/{geo_coordinates.py → entity/geo_coordinates.py}

@@ -1,5 +1,5 @@
-from .agents_model import AgentsModel
-from ._type_aliases import NonEmptyString
+from ..agents_model import AgentsModel
+from .._type_aliases import NonEmptyString
 
 
 class GeoCoordinates(AgentsModel):

microsoft_agents/activity/{mention.py → entity/mention.py}

@@ -1,13 +1,15 @@
-from .channel_account import ChannelAccount
+from typing import Literal
+
+from ..channel_account import ChannelAccount
 from .entity import Entity
-from ._type_aliases import NonEmptyString
+from .._type_aliases import NonEmptyString
 
 
 class Mention(Entity):
     """Mention information (entity type: "mention").
 
     :param mentioned: The mentioned user
-    :type mentioned: ~microsoft_agents.protocols.models.ChannelAccount
+    :type mentioned: ~microsoft_agents.activity.ChannelAccount
     :param text: Sub Text which represents the mention (can be null or empty)
     :type text: str
     :param type: Type of this entity (RFC 3987 IRI)
@@ -15,5 +17,5 @@ class Mention(Entity):
     """
 
     mentioned: ChannelAccount = None
-    text: NonEmptyString = None
-    type: NonEmptyString = None
+    text: str = None
+    type: Literal["mention"] = "mention"

microsoft_agents/activity/{place.py → entity/place.py}

@@ -1,5 +1,5 @@
-from .agents_model import AgentsModel
-from ._type_aliases import NonEmptyString
+from ..agents_model import AgentsModel
+from .._type_aliases import NonEmptyString
 
 
 class Place(AgentsModel):

microsoft_agents/activity/{thing.py → entity/thing.py}

@@ -1,5 +1,5 @@
-from .agents_model import AgentsModel
-from ._type_aliases import NonEmptyString
+from ..agents_model import AgentsModel
+from .._type_aliases import NonEmptyString
 
 
 class Thing(AgentsModel):

microsoft_agents/activity/error.py

@@ -11,7 +11,7 @@ class Error(AgentsModel):
     :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
+    :type inner_http_error: ~microsoft_agents.activity.InnerHttpError
     """
 
     code: NonEmptyString = None

microsoft_agents/activity/error_response.py

@@ -6,7 +6,7 @@ class ErrorResponse(AgentsModel):
     """An HTTP API response.
 
     :param error: Error message
-    :type error: ~microsoft_agents.protocols.models.Error
+    :type error: ~microsoft_agents.activity.Error
     """
 
     error: Error = None

microsoft_agents/activity/expected_replies.py

@@ -7,7 +7,7 @@ class ExpectedReplies(AgentsModel):
 
     :param activities: A collection of Activities that conforms to the
      ExpectedReplies schema.
-    :type activities: list[~microsoft_agents.protocols.models.Activity]
+    :type activities: list[~microsoft_agents.activity.Activity]
     """
 
     activities: list[Activity] = None

microsoft_agents/activity/hero_card.py

@@ -14,17 +14,17 @@ class HeroCard(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/media_card.py

@@ -15,12 +15,12 @@ class MediaCard(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 MediaCard(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/message_reaction.py

@@ -7,7 +7,7 @@ class MessageReaction(AgentsModel):
 
     :param type: Message reaction type. Possible values include: 'like',
      'plusOne'
-    :type type: str or ~microsoft_agents.protocols.models.MessageReactionTypes
+    :type type: str or ~microsoft_agents.activity.MessageReactionTypes
     """
 
     type: NonEmptyString

microsoft_agents/activity/oauth_card.py

@@ -14,10 +14,10 @@ class OAuthCard(AgentsModel):
     :param connection_name: The name of the registered connection
     :type connection_name: str
     :param buttons: Action to use to perform signin
-    :type buttons: list[~microsoft_agents.protocols.models.CardAction]
+    :type buttons: list[~microsoft_agents.activity.CardAction]
     """
 
-    text: NonEmptyString = None
+    text: str = None
     connection_name: NonEmptyString = None
     buttons: list[CardAction] = None
     token_exchange_resource: Optional[TokenExchangeResource] = None

microsoft_agents/activity/paged_members_result.py

@@ -9,7 +9,7 @@ class PagedMembersResult(AgentsModel):
     :param continuation_token: Paging token
     :type continuation_token: str
     :param members: The Channel Accounts.
-    :type members: list[~microsoft_agents.protocols.models.ChannelAccount]
+    :type members: list[~microsoft_agents.activity.ChannelAccount]
     """
 
     continuation_token: NonEmptyString = None

microsoft_agents/activity/receipt_card.py

@@ -11,11 +11,11 @@ class ReceiptCard(AgentsModel):
     :param title: Title of the card
     :type title: str
     :param facts: Array of Fact objects
-    :type facts: list[~microsoft_agents.protocols.models.Fact]
+    :type facts: list[~microsoft_agents.activity.Fact]
     :param items: Array of Receipt Items
-    :type items: list[~microsoft_agents.protocols.models.ReceiptItem]
+    :type items: list[~microsoft_agents.activity.ReceiptItem]
     :param tap: This action will be activated when user taps on the card
-    :type tap: ~microsoft_agents.protocols.models.CardAction
+    :type tap: ~microsoft_agents.activity.CardAction
     :param total: Total amount of money paid (or to be paid)
     :type total: str
     :param tax: Total amount of tax paid (or to be paid)
@@ -23,7 +23,7 @@ class ReceiptCard(AgentsModel):
     :param vat: Total amount of VAT paid (or to be paid)
     :type vat: str
     :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]
     """
 
     title: NonEmptyString = None

microsoft_agents/activity/receipt_item.py

@@ -16,19 +16,19 @@ class ReceiptItem(AgentsModel):
      in font styling only
     :type text: str
     :param image: Image
-    :type image: ~microsoft_agents.protocols.models.CardImage
+    :type image: ~microsoft_agents.activity.CardImage
     :param price: Amount with currency
     :type price: str
     :param quantity: Number of items of given kind
     :type quantity: str
     :param tap: This action will be activated when user taps on the Item
      bubble.
-    :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
     image: CardImage = None
     price: NonEmptyString = None
     quantity: NonEmptyString = None

microsoft_agents/activity/role_types.py

@@ -5,3 +5,5 @@ class RoleTypes(str, Enum):
     user = "user"
     agent = "bot"
     skill = "skill"
+    agentic_identity = "agenticAppInstance"
+    agentic_user = "agenticUser"

microsoft_agents/activity/semantic_action.py

@@ -8,9 +8,9 @@ class SemanticAction(AgentsModel):
     :param id: ID of this action
     :type id: str
     :param entities: Entities associated with this action
-    :type entities: dict[str, ~microsoft_agents.protocols.models.Entity]
+    :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 ~microsoft_agents.protocols.models.SemanticActionStates
+    :type state: str or :class:`microsoft_agents.activity.semantic_action_states.SemanticActionStates`
     """
 
     id: NonEmptyString

microsoft_agents/activity/signin_card.py

@@ -9,8 +9,8 @@ class SigninCard(AgentsModel):
     :param text: Text for signin request
     :type text: str
     :param buttons: Action to use to perform signin
-    :type buttons: list[~microsoft_agents.protocols.models.CardAction]
+    :type buttons: list[~microsoft_agents.activity.CardAction]
     """
 
-    text: NonEmptyString = None
+    text: str = None
     buttons: list[CardAction] = None

microsoft_agents/activity/suggested_actions.py

@@ -11,7 +11,7 @@ class SuggestedActions(AgentsModel):
      the activity
     :type to: list[str]
     :param actions: Actions that can be shown to the user
-    :type actions: list[~microsoft_agents.protocols.models.CardAction]
+    :type actions: list[~microsoft_agents.activity.CardAction]
     """
 
     to: list[NonEmptyString]

microsoft_agents/activity/text_highlight.py

@@ -12,5 +12,5 @@ class TextHighlight(AgentsModel):
     :type occurrence: int
     """
 
-    text: NonEmptyString
+    text: str
     occurrence: int

microsoft_agents/activity/thumbnail_card.py

@@ -14,17 +14,17 @@ class ThumbnailCard(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/token_exchange_state.py

@@ -14,9 +14,9 @@ class TokenExchangeState(AgentsModel):
     :param connection_name: The connection name that was used.
     :type connection_name: str
     :param conversation: Gets or sets a reference to the conversation.
-    :type conversation: ~microsoft_agents.protocols.models.ConversationReference
+    :type conversation: ~microsoft_agents.activity.ConversationReference
     :param relates_to: Gets or sets a reference to a related parent conversation for this token exchange.
-    :type relates_to: ~microsoft_agents.protocols.models.ConversationReference
+    :type relates_to: ~microsoft_agents.activity.ConversationReference
     :param agent_url: The URL of the agent messaging endpoint.
     :type agent_url: str
     :param ms_app_id: The agent's registered application ID.

microsoft_agents/activity/token_response.py

@@ -1,6 +1,8 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 
+import jwt
+
 from .agents_model import AgentsModel
 from ._type_aliases import NonEmptyString
 
@@ -26,3 +28,19 @@ class TokenResponse(AgentsModel):
 
     def __bool__(self):
         return bool(self.token)
+
+    def is_exchangeable(self) -> bool:
+        """
+        Checks if a token is exchangeable (has api:// audience).
+
+        :param token: The token to check.
+        :type token: str
+        :return: True if the token is exchangeable, False otherwise.
+        """
+        try:
+            # Decode without verification to check the audience
+            payload = jwt.decode(self.token, options={"verify_signature": False})
+            aud = payload.get("aud")
+            return isinstance(aud, str) and aud.startswith("api://")
+        except Exception:
+            return False

microsoft_agents/activity/transcript.py

@@ -7,7 +7,7 @@ class Transcript(AgentsModel):
 
     :param activities: A collection of Activities that conforms to the
      Transcript schema.
-    :type activities: list[~microsoft_agents.protocols.models.Activity]
+    :type activities: list[~microsoft_agents.activity.Activity]
     """
 
     activities: list[Activity] = None

microsoft_agents/activity/video_card.py

@@ -15,12 +15,12 @@ class VideoCard(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 VideoCard(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.1.dist-info → microsoft_agents_activity-0.4.0.dist-info}/METADATA

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