@microsoft/agents-hosting-dialogs package

Waits for an activity to be received.

Abstract base class for defining an AgentComponent.

Base class for memory scopes based on AgentState.

A class that resolves paths by replacing an alias with a specified prefix and optional postfix. This is useful for transforming paths that use shorthand aliases into fully qualified paths.

A specialized path resolver that replaces the '@@' alias with the prefix 'turn.recognized.entities.'. This is used to resolve paths related to recognized entities in a conversational turn.

A path resolver that replaces the '@' alias with a specific prefix and transforms paths to access recognized entities in a conversational turn. It ensures that the resolved path includes the 'first()' function for entity properties.

Prompts a user to upload attachments like images.

A set of utility functions to assist with the formatting a 'message' activity containing a list of choices.

Prompts a user to select from a list of choices.

A memory scope that provides access to the properties of the active dialog. This scope binds to the active dialog and clones its properties for use in memory.

Base class for a dialog that contains other child dialogs.

Base class for all configurable classes.

Prompts a user to confirm something with a "yes" or "no" response.

Memory that's scoped to the current conversation.

Prompts a user to enter a datetime expression.

Defines the core behavior for all dialogs.

A memory scope that provides access to the properties of the active dialog class. This scope resolves to the active dialog if it is a container, or to its parent dialog.

A container for a set of Dialogs.

The context for the current dialog turn with respect to a specific DialogSet.

An Error that includes extra dialog context, including the dialog stack.

A memory scope that provides access to the dialog context. This scope includes information about the active dialog, its parent, and the dialog stack.

Represents the events related to the "lifecycle" of the dialog.

These events are used to signal various stages or actions within a dialog's lifecycle.

Class which runs the dialog system.

A memory scope that provides access to the active dialog's state. This scope binds to the active dialog if it is a container, or to its parent dialog if applicable.

Defines path for available dialogs.

A related set of dialogs that can all call each other.

Manages memory scopes and path resolvers.

Provides constants used to manage the state of a dialog turn.

Agent component for agent Dialogs.

A path resolver that resolves paths starting with a dollar sign ('$') to the 'dialog.' namespace.

A path resolver that resolves paths starting with a hash sign ('#') to the 'turn.recognized.intents.' namespace.

Abstract base class for all memory scopes.

Prompts a user to enter a number.

A path resolver that resolves paths starting with a percent sign ('%') to the 'class.' namespace.

Base class for all prompts.

Class container for currently-supported Culture Models in Confirm and Choice Prompt.

Base class for implementing custom recognizers to identify intents and entities from user input.

Defines paths for the available scopes.

ServiceCollection is an interface that describes a set of methods to register services. This, in a lighter way, mimics the .NET dependency injection service collection functionality, except for instances rather than types.

Abstract base class for all memory scopes.

Prompts a user to enter some text.

Abstract base class for all memory scopes.

A memory scope that provides access to the turn's state. This scope is used to store and retrieve information specific to the current turn.

Defines path for available turns.

Memory that's scoped to the current user.

A waterfall is a dialog that's optimized for prompting a user with a series of questions.

Context object passed in to a WaterfallStep.

An instance of a choice that can be used to render a choice to a user or recognize something a user picked.

Represents a dictionary of default choice options for different locales.

Defines locale-specific choice defaults for confirmation prompts.

Additional options used to tweak the formatting of choice lists.

Interface for enumerating memory scopes.

Interface for declaring path resolvers.

Configuration is an interface that is used to obtain configurable values

The converter converts objects from one type to another.

Result returned by the DateTimePrompt.

Configuration options for dialog initialization and behavior. This interface defines the settings that can be applied when creating or configuring a dialog instance.

Interface for dialogs that have child dialog dependencies.

Represents an event that occurs within a dialog, providing details such as its name, whether it should bubble to parent contexts, and any associated value.

Contains state information for an instance of a dialog on the stack.

Configuration interface for DialogManager instances. Defines the required and optional settings needed to initialize and configure a dialog manager.

Result returned by the DialogManager after processing a conversation turn. Contains the outcome of dialog execution and any state changes that occurred during the turn.

Contains dialog state, information about the state of the dialog stack, for a specific DialogSet.

Configuration options for the DialogStateManager.

Represents the result of a dialog context's attempt to begin, continue, or otherwise manipulate one or more dialogs.

Basic search options used to control how choices are recognized in a users utterance.

Basic search options used to control how choices are recognized in a users utterance.

Represents a choice that was found and matched within a user's utterance. This interface contains information about the matched choice, including its original value, position in the choices list, confidence score, and the specific text that triggered the match.

Represents a value that was successfully found and matched during a search operation.

Score plus any extra information about an intent.

Represents the result of a model recognition process.

Interface for resolving and transforming paths. Implementations of this interface define how specific path patterns should be transformed into other formats or namespaces.

Represents a culture-specific model that defines localization settings for prompts. This interface provides language-specific formatting rules and translations for interactive prompts such as choice lists and confirmation dialogs.

Basic configuration options supported by all prompts.

Result returned by a prompts recognizer function.

Contextual information passed to a custom PromptValidator.

Configuration options for a recognizer instance.

Value returned from a recognizer.

Represents a value with its original position that can be used in search operations.

Defines Template interface for binding data to T.

Represents a token extracted from a text string.

Values passed to the WaterfallStepContext constructor.

A factory type for creating instances of a Converter.

DependencyFactory is a function signature that produces an instance that depends on a set of other services. The type is generic over a few parameters:

Factory describes a generic factory function signature. The type is generic over a few parameters:

Function signature for providing a custom prompt validator.

Signature for an alternate word breaker.

Function signature of an individual waterfall step.

Indicates why a dialog method is being called.

Represents the state of the dialog stack after a dialog context attempts to begin, continue, or otherwise manipulate one or more dialogs.

Controls the way that choices for a ChoicePrompt or yes/no options for a ConfirmPrompt are presented to a user.

Simple tokenizer that breaks on spaces and punctuation.

Mid-level search function for recognizing a choice in an utterance.

Example

const result: RecognizerResult = {
  text: "Book a flight to Seattle",
  intents: {
    "BookFlight": { score: 0.95 },
    "Cancel": { score: 0.02 },
    "Help": { score: 0.03 }
  }
};

const topIntent = getTopScoringIntent(result);
// Returns: { intent: "BookFlight", score: 0.95 }

Check if a ComponentRegistration is ComponentMemoryScopes or not.

Check if a ComponentRegistration) is ComponentPathResolvers or not.

High level function for recognizing a choice in a users utterance.

Runs a dialog from a given context and accessor.