microsoft-agents-hosting-dialogs 0.10.0.dev2__tar.gz

microsoft_agents_hosting_dialogs-0.10.0.dev2/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

microsoft_agents_hosting_dialogs-0.10.0.dev2/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: microsoft-agents-hosting-dialogs
+Version: 0.10.0.dev2
+Summary: Dialog system for Microsoft Agents (waterfall dialogs, prompts, choices)
+Author: Microsoft Corporation
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/microsoft/Agents
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: microsoft-agents-hosting-core==0.10.0.dev2
+Requires-Dist: recognizers-text-number>=1.0.1a0
+Requires-Dist: recognizers-text-choice>=1.0.1a0
+Requires-Dist: recognizers-text-date-time>=1.0.1a0
+Requires-Dist: babel>=2.9.0
+Requires-Dist: emoji<2.0.0
+Dynamic: license-file
+Dynamic: requires-dist
+
+# Microsoft Agents Hosting - Dialogs
+
+[![PyPI version](https://img.shields.io/pypi/v/microsoft-agents-hosting-dialogs)](https://pypi.org/project/microsoft-agents-hosting-dialogs/)
+
+Dialog system for the Microsoft 365 Agents SDK. Provides waterfall dialogs, prompts, choice recognition, and multi-turn conversation management.
+
+This library is a port of the botbuilder-dialogs library to the new Microsoft 365 Agents SDK. It provides the same dialog primitives (WaterfallDialog, ComponentDialog, DialogSet, DialogContext) and prompts (TextPrompt, NumberPrompt, ChoicePrompt, ConfirmPrompt, DateTimePrompt, OAuthPrompt, etc.) with updated imports and patterns for the new SDK.
+
+## What is this?
+
+This library is part of the **Microsoft 365 Agents SDK for Python** - a comprehensive framework for building enterprise-grade conversational AI agents. The dialogs library enables developers to structure multi-turn conversations with reusable, composable dialog primitives.
+
+## Key Features
+
+- **WaterfallDialog**: Sequential step-by-step conversation flows
+- **ComponentDialog**: Composable, encapsulated dialog components
+- **Prompts**: Built-in prompts for text, numbers, choices, confirmations, dates, attachments, and OAuth
+- **Choice recognition**: Locale-aware choice matching and recognition
+- **Dialog memory**: Scoped memory management (conversation, user, dialog, class, settings)
+- **DialogManager**: High-level dialog orchestration with state management
+
+## Installation
+
+```bash
+pip install microsoft-agents-hosting-dialogs
+```
+
+## Quick Start
+
+```python
+from microsoft_agents.hosting.dialogs import (
+    WaterfallDialog,
+    WaterfallStepContext,
+    DialogSet,
+    DialogTurnStatus,
+)
+from microsoft_agents.hosting.dialogs.prompts import TextPrompt, PromptOptions
+from microsoft_agents.hosting.core import ConversationState, MemoryStorage
+
+storage = MemoryStorage()
+conversation_state = ConversationState(storage)
+dialog_state = conversation_state.create_property("DialogState")
+dialogs = DialogSet(dialog_state)
+
+async def step1(step: WaterfallStepContext):
+    return await step.prompt(
+        "text_prompt",
+        PromptOptions(prompt=MessageFactory.text("What is your name?"))
+    )
+
+async def step2(step: WaterfallStepContext):
+    await step.context.send_activity(f"Hello, {step.result}!")
+    return await step.end_dialog()
+
+dialogs.add(TextPrompt("text_prompt"))
+dialogs.add(WaterfallDialog("main", [step1, step2]))
+```
+
+## Release Notes
+
+See [CHANGELOG.md](https://github.com/microsoft/Agents/blob/main/CHANGELOG.md) for release history.

microsoft_agents_hosting_dialogs-0.10.0.dev2/microsoft_agents/hosting/dialogs/__init__.py

@@ -0,0 +1,76 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+__version__ = "0.0.0"
+
+from .component_dialog import ComponentDialog
+from .dialog_container import DialogContainer
+from .dialog_context import DialogContext
+from .models.dialog_event import DialogEvent
+from .models.dialog_events import DialogEvents
+from .models.dialog_instance import DialogInstance
+from .models.dialog_reason import DialogReason
+from .dialog_set import DialogSet
+from .dialog_state import DialogState
+from .models.dialog_turn_result import DialogTurnResult
+from .models.dialog_turn_status import DialogTurnStatus
+from .dialog_manager import DialogManager
+from .dialog_manager_result import DialogManagerResult
+from .dialog import Dialog
+from .dialog_component_registration import DialogsComponentRegistration
+from .persisted_state_keys import PersistedStateKeys
+from .persisted_state import PersistedState
+from .waterfall_dialog import WaterfallDialog
+from .waterfall_step_context import WaterfallStepContext
+from .dialog_extensions import DialogExtensions
+from .prompts import *
+from .choices import *
+from .object_path import ObjectPath
+from .models import (
+    DialogEvent,
+    DialogEvents,
+    DialogInstance,
+    DialogReason,
+    DialogTurnResult,
+    DialogTurnStatus,
+)
+
+__all__ = [
+    "ComponentDialog",
+    "DialogContainer",
+    "DialogContext",
+    "DialogEvent",
+    "DialogEvents",
+    "DialogInstance",
+    "DialogReason",
+    "DialogSet",
+    "DialogState",
+    "DialogTurnResult",
+    "DialogTurnStatus",
+    "DialogManager",
+    "DialogManagerResult",
+    "Dialog",
+    "DialogsComponentRegistration",
+    "WaterfallDialog",
+    "WaterfallStepContext",
+    "ConfirmPrompt",
+    "DateTimePrompt",
+    "DateTimeResolution",
+    "NumberPrompt",
+    "OAuthPrompt",
+    "OAuthPromptSettings",
+    "PersistedStateKeys",
+    "PersistedState",
+    "PromptRecognizerResult",
+    "PromptValidatorContext",
+    "Prompt",
+    "PromptOptions",
+    "TextPrompt",
+    "DialogExtensions",
+    "ObjectPath",
+    "__version__",
+]

microsoft_agents_hosting_dialogs-0.10.0.dev2/microsoft_agents/hosting/dialogs/_component_registration.py

@@ -0,0 +1,30 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import List
+
+
+class ComponentRegistration:
+    """
+    Simple component registration that allows dialogs and other components
+    to register memory scopes and path resolvers.
+    """
+
+    _components: List = []
+
+    @classmethod
+    def add(cls, component: object) -> None:
+        """
+        Register a component. Duplicate types are ignored.
+        :param component: The component instance to register.
+        """
+        if not any(type(c) == type(component) for c in cls._components):
+            cls._components.append(component)
+
+    @classmethod
+    def get_components(cls) -> List:
+        """
+        Gets all registered components.
+        :return: List of registered component instances.
+        """
+        return list(cls._components)

microsoft_agents_hosting_dialogs-0.10.0.dev2/microsoft_agents/hosting/dialogs/_telemetry_client.py

@@ -0,0 +1,78 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+
+class AgentTelemetryClient:
+    """
+    Interface for telemetry logging. Override to send telemetry to a custom sink.
+    """
+
+    def track_event(
+        self,
+        name: str,
+        properties: dict[str, str] | None = None,
+        metrics: dict[str, float] | None = None,
+    ) -> None:
+        pass
+
+    def track_exception(
+        self,
+        exception: Exception,
+        properties: dict[str, str] | None = None,
+        measurements: dict[str, float] | None = None,
+    ) -> None:
+        pass
+
+    def track_dependency(
+        self,
+        name: str,
+        data: str | None = None,
+        type_name: str | None = None,
+        target: str | None = None,
+        duration: int | None = None,
+        success: bool = True,
+        result_code: str | None = None,
+        properties: dict[str, str] | None = None,
+    ) -> None:
+        pass
+
+    def flush(self) -> None:
+        pass
+
+
+class NullTelemetryClient(AgentTelemetryClient):
+    """
+    No-op telemetry client. All calls are silently discarded.
+    """
+
+    def track_event(
+        self,
+        name: str,
+        properties: dict[str, str] | None = None,
+        metrics: dict[str, float] | None = None,
+    ) -> None:
+        pass
+
+    def track_exception(
+        self,
+        exception: Exception,
+        properties: dict[str, str] | None = None,
+        measurements: dict[str, float] | None = None,
+    ) -> None:
+        pass
+
+    def track_dependency(
+        self,
+        name: str,
+        data: str | None = None,
+        type_name: str | None = None,
+        target: str | None = None,
+        duration: int | None = None,
+        success: bool = True,
+        result_code: str | None = None,
+        properties: dict[str, str] | None = None,
+    ) -> None:
+        pass
+
+    def flush(self) -> None:
+        pass

microsoft_agents_hosting_dialogs-0.10.0.dev2/microsoft_agents/hosting/dialogs/choices/__init__.py

@@ -0,0 +1,38 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+from .channel import Channel
+from .models.choice import Choice
+from .models.choice_factory_options import ChoiceFactoryOptions
+from .choice_factory import ChoiceFactory
+from .choice_recognizer import ChoiceRecognizers
+from .find import Find
+from .models.find_choices_options import FindChoicesOptions, FindValuesOptions
+from .models.found_choice import FoundChoice
+from .models.found_value import FoundValue
+from .models.list_style import ListStyle
+from .models.model_result import ModelResult
+from .models.sorted_value import SortedValue
+from .models.token import Token
+from .tokenizer import Tokenizer
+
+__all__ = [
+    "Channel",
+    "Choice",
+    "ChoiceFactory",
+    "ChoiceFactoryOptions",
+    "ChoiceRecognizers",
+    "Find",
+    "FindChoicesOptions",
+    "FindValuesOptions",
+    "FoundChoice",
+    "ListStyle",
+    "ModelResult",
+    "SortedValue",
+    "Token",
+    "Tokenizer",
+]

microsoft_agents_hosting_dialogs-0.10.0.dev2/microsoft_agents/hosting/dialogs/choices/channel.py

@@ -0,0 +1,121 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from microsoft_agents.hosting.core import TurnContext
+from microsoft_agents.activity import Channels
+
+
+class Channel:
+    """
+    Methods for determining channel-specific functionality.
+    """
+
+    @staticmethod
+    def supports_suggested_actions(channel_id: str, 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.
+        """
+        if isinstance(channel_id, Channels):
+            channel_id = channel_id.value
+
+        max_actions = {
+            # https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies
+            Channels.facebook.value: 10,
+            Channels.skype.value: 10,
+            # https://developers.line.biz/en/reference/messaging-api/#items-object
+            Channels.line.value: 13,
+            # https://dev.kik.com/#/docs/messaging#text-response-object
+            Channels.kik.value: 20,
+            Channels.telegram.value: 100,
+            Channels.emulator.value: 100,
+            Channels.direct_line.value: 100,
+            Channels.direct_line_speech.value: 100,
+            Channels.webchat.value: 100,
+        }
+        return (
+            button_cnt <= max_actions[channel_id]
+            if channel_id in max_actions
+            else False
+        )
+
+    @staticmethod
+    def supports_card_actions(channel_id: str, 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.
+        """
+        if isinstance(channel_id, Channels):
+            channel_id = channel_id.value
+
+        max_actions = {
+            Channels.facebook.value: 3,
+            Channels.skype.value: 3,
+            Channels.ms_teams.value: 3,
+            Channels.line.value: 99,
+            Channels.slack.value: 100,
+            Channels.telegram.value: 100,
+            Channels.emulator.value: 100,
+            Channels.direct_line.value: 100,
+            Channels.direct_line_speech.value: 100,
+            Channels.webchat.value: 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 get_channel_id(turn_context: TurnContext) -> str:
+        """Get the channel ID from the TurnContext's activity.
+
+        Args:
+            turn_context (TurnContext): The current turn context.
+
+        Returns:
+            str: The channel ID, or an empty string if not set.
+        """
+        if turn_context.activity and turn_context.activity.channel_id:
+            return turn_context.activity.channel_id
+        return ""
+
+    @staticmethod
+    def max_action_title_length(  # pylint: disable=unused-argument
+        channel_id: str,
+    ) -> 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