Share via


DialogManagerConfiguration interface

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

Properties

conversationState

The conversation state storage for maintaining dialog state across turns. This is required and manages the dialog stack and conversation-scoped data.

expireAfter

Optional timeout duration in milliseconds after which inactive conversations expire. When set, conversations that haven't been accessed within this timeframe will have their state cleared. If not specified, conversations will not automatically expire.

rootDialog

The root dialog that will be started when the dialog manager begins execution. This dialog serves as the entry point for the conversation flow.

stateConfiguration

Optional configuration for the dialog state manager. Provides advanced settings for how dialog state is managed and persisted.

userState

Optional user state storage for maintaining user-scoped data across conversations. When provided, enables persistence of user-specific information beyond individual conversations.

Property Details

conversationState

The conversation state storage for maintaining dialog state across turns. This is required and manages the dialog stack and conversation-scoped data.

conversationState: AgentState

Property Value

expireAfter

Optional timeout duration in milliseconds after which inactive conversations expire. When set, conversations that haven't been accessed within this timeframe will have their state cleared. If not specified, conversations will not automatically expire.

expireAfter?: number

Property Value

number

rootDialog

The root dialog that will be started when the dialog manager begins execution. This dialog serves as the entry point for the conversation flow.

rootDialog: Dialog<{}>

Property Value

Dialog<{}>

stateConfiguration

Optional configuration for the dialog state manager. Provides advanced settings for how dialog state is managed and persisted.

stateConfiguration?: DialogStateManagerConfiguration

Property Value

userState

Optional user state storage for maintaining user-scoped data across conversations. When provided, enables persistence of user-specific information beyond individual conversations.

userState?: UserState

Property Value