Skip to main content

Dialog system for Microsoft Agents (waterfall dialogs, prompts, choices)

Project description

Microsoft Agents Hosting - Dialogs

PyPI version

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

pip install microsoft-agents-hosting-dialogs

Quick Start

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 for release history.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

microsoft_agents_hosting_dialogs-0.10.0.dev8.tar.gz (60.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file microsoft_agents_hosting_dialogs-0.10.0.dev8.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-0.10.0.dev8.tar.gz
Algorithm Hash digest
SHA256 968c30e7516a5f4144e8565d61499c323a733b0a827f15cf140f25a85839fb47
MD5 4a00ccc12bed521d36929b55a51c28f7
BLAKE2b-256 70a45fb985beea3ce25711d58f46fcff3340d7b1f53474d8643cc62d1baaf067

See more details on using hashes here.

File details

Details for the file microsoft_agents_hosting_dialogs-0.10.0.dev8-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-0.10.0.dev8-py3-none-any.whl
Algorithm Hash digest
SHA256 a4f429b3f139e851a19dbde3e26301aaa368bc4d9eb88709a7436956843d59c5
MD5 5c578f7ea1e20e964ff1e54ee7ab96e5
BLAKE2b-256 54682b48fdc7a5f2c34cd8f0b4c6b3782777a1d2436493ed8c8f2d24bd8de13e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page