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.1.0 2026-06-19 1.1.0 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.2.0.dev1.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.2.0.dev1.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-1.2.0.dev1.tar.gz
Algorithm Hash digest
SHA256 c34b769bb413dc94cb9b78748535da3c8ef8a889db25965aa1a0ac24c60bc849
MD5 e7cd884e144604882499ec6df6ba96ad
BLAKE2b-256 2ca2f251b1569e9355d0600e1b1305e9ab44654d1ecb9d6c8c9713f45bcc748a

See more details on using hashes here.

File details

Details for the file microsoft_agents_hosting_dialogs-1.2.0.dev1-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-1.2.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 371034c5fc87e395d6366d26c29ec1c685caab31911bb9236fe859f12872a2ed
MD5 c6382e63dd72984f4850371febfc164b
BLAKE2b-256 8a747b97ca8b0d4ed9503b70634b649c0c8b04e1c73c56f191683664fe774d05

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