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

Version Date Release Notes
1.0.0 2026-05-22 1.0.0 Release Notes

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-1.1.0.dev0.tar.gz (60.3 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-1.1.0.dev0.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-1.1.0.dev0.tar.gz
Algorithm Hash digest
SHA256 6373a42caef2bd92f501b5fd53d89164f49b7aa3cc1a650399e3a2fd5b0d5d02
MD5 78f6e355341686b55a94008e74c7a02b
BLAKE2b-256 eb34fde6946689fd79350c33a8654f237287492c1097377d19465704791d3293

See more details on using hashes here.

File details

Details for the file microsoft_agents_hosting_dialogs-1.1.0.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-1.1.0.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 51521cd53398a4307430f376f7866cafab140dd8a2d6f575b8e082febf317715
MD5 22889a3fd3ca5199268beca756932cf7
BLAKE2b-256 0b0b407b515a5433c136be7150b8272da69d90c12d8262b6a3778cef9a4ce73f

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