AdaptiveDialog class
自适应对话使用事件和事件对对话进行建模,以动态适应不断变化的聊天流。
- Extends
-
DialogContainer<O>
构造函数
Adaptive |
创建一个新的 |
属性
$kind | |
auto |
在没有要执行的操作时是否结束对话。 |
condition |
|
default |
当没有更多 Actions 和 |
generator | 可选。 语言生成器替代。 |
recognizer | 可选。 用于分析任何消息话语的识别器。 |
schema | 设置对话框的 JSON 架构。 获取对话框的 JSON 架构。 |
selector | 可选。 用于选择要执行的事件的选择器。 |
triggers | 触发处理程序以响应修改执行计划的条件。 |
继承属性
dialogs | 容器对话集。 |
End |
获取默认的轮次结束结果。 |
id | |
telemetry |
方法
begin |
启动对话并推送到对话堆栈时调用。 |
continue |
当对话 继续时调用,其中它是活动对话,用户使用新活动进行回复。 |
create |
为给定上下文创建一个子 DialogContext 。 |
end |
在对话结束时调用。 |
get |
|
get |
获取 对话框 枚举依赖项。 |
reprompt |
重新配置用户。 |
resume |
当子对话完成其轮次时调用,将控件返回到此对话。 |
继承的方法
configure(Record<string, unknown>) | 用于配置 对象的 Fluent 方法。 |
find |
查找以前添加到容器的子对话。 |
get |
一个编码字符串,用于帮助在重新部署时检测机器人更改。 |
on |
在引发事件时调用,使用 |
构造函数详细信息
AdaptiveDialog(string)
创建一个新的 AdaptiveDialog
实例。
new AdaptiveDialog(dialogId?: string)
参数
- dialogId
-
string
(组件的父对话集中的可选) 唯一 ID。
属性详细信息
$kind
static $kind: string
属性值
string
autoEndDialog
在没有要执行的操作时是否结束对话。
autoEndDialog: BoolExpression
属性值
BoolExpression
注解
如果为 true,则当没有要执行的操作时,当前对话框将结束。 如果为 false,则当没有要执行的操作时,当前对话框将简单地结束轮次,并且仍然处于活动状态。 默认值为 true。
conditionTracker
static conditionTracker: string
属性值
string
defaultResultProperty
当没有更多 Actions 和 AutoEndDialog = true
时,对话框结束时要作为结果返回的属性。
defaultResultProperty: string
属性值
string
注解
默认值为 值 dialog.result
。
generator
recognizer
可选。 用于分析任何消息话语的识别器。
recognizer?: Recognizer
属性值
Recognizer
schema
设置对话框的 JSON 架构。 获取对话框的 JSON 架构。
object schema
属性值
object
对话架构。
selector
triggers
继承属性详细信息
dialogs
容器对话集。
dialogs: DialogSet
属性值
DialogSet
继承自 DialogContainer.dialogs
EndOfTurn
获取默认的轮次结束结果。
static EndOfTurn: DialogTurnResult
属性值
DialogTurnResult
注解
此结果指示对话 (或对话中的逻辑步骤) 已完成当前轮次的处理,仍处于活动状态,并且正在等待更多输入。
继承自 Dialog.EndOfTurn
id
id: string
属性值
string
继承自 Dialog.id
telemetryClient
telemetryClient: BotTelemetryClient
属性值
BotTelemetryClient
继承自 DialogContainer.telemetryClient
方法详细信息
beginDialog(DialogContext, O)
启动对话并推送到对话堆栈时调用。
function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>
参数
- dc
-
DialogContext
对话当前轮次的 DialogContext 。
- options
-
O
要传递给对话框的可选初始信息。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise。
continueDialog(DialogContext)
当对话 继续时调用,其中它是活动对话,用户使用新活动进行回复。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
参数
- dc
-
DialogContext
对话当前轮次的 DialogContext 。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise。
createChildContext(DialogContext)
为给定上下文创建一个子 DialogContext 。
function createChildContext(dc: DialogContext): DialogContext
参数
- dc
-
DialogContext
对话当前轮次的 DialogContext 。
返回
DialogContext
如果找不到给定上下文的 AdaptiveDialogState.actions,则为子 DialogContext 或 null。
endDialog(TurnContext, DialogInstance, DialogReason)
在对话结束时调用。
function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>
参数
- turnContext
-
TurnContext
此轮次的上下文对象。
- instance
-
DialogInstance
与对话堆栈上此对话的实例关联的状态信息。
- reason
-
DialogReason
对话框结束的原因。
返回
Promise<void>
表示异步操作的 Promise。
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
参数
- property
-
Object
条件选择器配置的键。
返回
Converter | ConverterFactory
选择器配置的转换器。
getDependencies()
获取 对话框 枚举依赖项。
function getDependencies(): Dialog[]
返回
Dialog[]
(xref:botbuilder-dialogs。对话框) 的枚举依赖项。
repromptDialog(DialogContext | TurnContext, DialogInstance)
重新配置用户。
function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>
参数
- context
-
DialogContext | TurnContext
轮次的上下文对象。
- instance
-
DialogInstance
此对话框的当前状态信息。
返回
Promise<void>
表示异步操作的 Promise。
resumeDialog(DialogContext, DialogReason, any)
当子对话完成其轮次时调用,将控件返回到此对话。
function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>
参数
- dc
-
DialogContext
当前会话轮次的对话上下文。
- _reason
-
DialogReason
对话恢复的原因。
- _result
-
any
可选,从调用的对话框返回的值。 返回的值的类型取决于子对话。
返回
Promise<DialogTurnResult>
表示异步操作的 Promise。
继承的方法详细信息
configure(Record<string, unknown>)
用于配置 对象的 Fluent 方法。
function configure(config: Record<string, unknown>): this
参数
- config
-
Record<string, unknown>
要应用的配置设置。
返回
this
继承自 Configure.configure
findDialog(string)
查找以前添加到容器的子对话。
function findDialog(dialogId: string): Dialog | undefined
参数
- dialogId
-
string
要查找的对话框的 ID。
返回
Dialog | undefined
如果找到对话框,则为 ;否则为 null。
继承自 DialogContainer.findDialog
getVersion()
一个编码字符串,用于帮助在重新部署时检测机器人更改。
function getVersion(): string
返回
string
唯一字符串,仅当对话已以应重启对话框的方式更改时才应更改。
注解
这默认返回对话 ID ,但可以重写以提供更精确的更改检测逻辑。 堆栈上具有其版本更改的任何对话都将导致 versionChanged
引发事件。 如果机器人未处理此事件,则会引发错误,从而导致运行机器人错误处理程序逻辑。
返回空字符串将一起禁用组件的版本跟踪。
继承自 Dialog.getVersion
onDialogEvent(DialogContext, DialogEvent)
在引发事件时调用,使用 DialogContext.emitEvent()
由当前对话或当前对话启动的对话调用。
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>
参数
- dc
-
DialogContext
当前会话轮次的对话上下文。
- e
-
DialogEvent
正在引发的事件。
返回
Promise<boolean>
如此 如果事件由当前对话框处理,并且浮泡应停止。
继承自 DialogContainer.onDialogEvent