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

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.dev4.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-0.10.0.dev4.tar.gz
Algorithm Hash digest
SHA256 538b944b7424042653a61c888da6819a6e65724923b429ffeb0c6a1fddfebaa7
MD5 67b257246c137b92e9d42558313b52dd
BLAKE2b-256 ead031b374e4275cced2058acd0bcd579bf3e0fb0a1de2f1c06c6468007f7b1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for microsoft_agents_hosting_dialogs-0.10.0.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 cfbff705533baddd0f5627764c25edd00a877bbd3c000a48769fe2ec4a37edb1
MD5 34c3cec0410f66e8da1264a6f69bad34
BLAKE2b-256 7261526592262256c2a0d23acac9a75a3ed9271be8240ec195059ce19c9efe1f

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