QnAMakerDialog class

Ссылка

Пакет:: botbuilder-ai

Диалоговое окно, которое поддерживает многофакторные и адаптивные службы QnA Maker.

Extends: WaterfallDialog

Конструкторы

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Инициализирует новый экземпляр класса QnAMakerDialog.
QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Инициализирует новый экземпляр класса QnAMakerDialog.

Свойства

$kind
activeLearningCardTitle	Получает или задает заголовок карточки, используемый при отображении параметров активного обучения пользователю. Примечание. Если предложениеActivityFactory передается, этот элемент не используется.
cardNoMatchResponse	Возвращает или задает шаблон для отправки пользователю, если он выбирает параметр соответствия на активной карточке обучения.
cardNoMatchText	Возвращает или задает текст кнопки, используемый с активными параметрами обучения, что позволяет пользователю указывать, что параметры не применимы. Примечание. Если предложениеActivityFactory передается, этот элемент требуется.
displayPreciseAnswerOnly	Возвращает или задает значение, указывающее, должен ли ответ диалогового окна отображать только точные ответы.
enablePreciseAnswer	Возвращает или задает значение, указывающее, следует ли включать точный ответ в ответ.
endpointKey	Возвращает или задает ключ конечной точки QnA Maker, используемый для запроса базы знаний.
filters	Возвращает или задает метаданные и источники, используемые для фильтрации результатов.
hostname	Возвращает или задает URL-адрес узла QnA Maker для базы знаний.
includeUnstructuredSources	Возвращает или задает значение, указывающее, следует ли включать неструктурированные источники в поиске ответов.
isTest	Возвращает или задает значение, указывающее, следует ли вызывать среду базы знаний или задать ее.
knowledgeBaseId	Возвращает или задает идентификатор базы знаний QnA Maker для запроса.
logPersonalInformation	Получает или задает флаг, чтобы определить, следует ли регистрировать персональные данные в телеметрии.
noAnswer	Получает или задает шаблон для отправки пользователю, когда QnA Maker не находит ответ.
qnaServiceType	Тип службы ответов на вопросы — qnaMaker или язык
rankerType	Возвращает или задает используемый тип ранжирования QnA Maker.
strictFilters	Возвращает или задает метаданные QnA Maker, с помощью которых можно фильтровать или повышать запросы к базе знаний, или значение NULL, чтобы применить его.
strictFiltersJoinOperator	Возвращает или задает значение — И ИЛИ — логическая операция в списке метаданных
threshold	Возвращает или задает пороговое значение для возвращаемых ответов на основе оценки.
top	Возвращает или задает максимальное количество ответов, возвращаемых из базы знаний.

Унаследованные свойства

EndOfTurn	Возвращает результат конца по умолчанию.
id
telemetryClient

Методы

beginDialog(DialogContext, object)	Вызывается при запуске диалогового окна и отправке в стек диалогов.
continueDialog(DialogContext)	Вызывается, когда диалоговое окно продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.
getConverter(Object)

Наследуемые методы

addStep(WaterfallStep<O>)	Добавляет новый шаг в каскад.
configure(Record<string, unknown>)	Метод Fluent для настройки объекта.
endDialog(TurnContext, DialogInstance, DialogReason)	Вызывается, когда диалоговое окно заканчивается.
getVersion()	Возвращает версию диалогового окна, состоящую из идентификатора и количества шагов.
onDialogEvent(DialogContext, DialogEvent)	Вызывается при возникновении события, используя `DialogContext.emitEvent()`, текущим диалогом или диалогом, запущенным текущим диалогом.
repromptDialog(TurnContext, DialogInstance)	При переопределении в производном классе переиздает пользователя для ввода.
resumeDialog(DialogContext, DialogReason, any)	Вызывается, когда дочерний Каскадныйdialog завершил свою очередь, возвращая элемент управления в этом диалоговом окне.

Сведения о конструкторе

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Инициализирует новый экземпляр класса QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, suggestionsActivityFactory?: QnASuggestionsActivityFactory, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Параметры

knowledgeBaseId: string

Идентификатор базы знаний QnA Maker для запроса.

endpointKey: string

Ключ конечной точки QnA Maker, используемый для запроса базы знаний.

hostname: string

URL-адрес узла QnA Maker для базы знаний, начиная с "https://" и заканчивая "/qnamaker".

noAnswer: Activity

(Необязательно) Действие для отправки пользователя, когда QnA Maker не находит ответ.

threshold: number

(Необязательно) Пороговое значение, указанное выше для обработки ответов, найденных из базы знаний в качестве совпадения.

suggestionsActivityFactory: QnASuggestionsActivityFactory

(xref:botbuilder-ai. QnASuggestionsActivityFactory) используется для форматирования пользовательских действий.

cardNoMatchText: string

(Необязательно) Текст кнопки, используемый с активными параметрами обучения, что позволяет пользователю указывать, что ни один из параметров не применяется.

top: number

(Необязательно) Максимальное количество ответов, возвращаемых из базы знаний.

cardNoMatchResponse: Activity

(Необязательно) Действие для отправки пользователя, если он выбирает параметр соответствия на активной карточке обучения.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Необязательно) Метаданные QnA Maker, с помощью которых выполняется фильтрация или повышение запросов к базе знаний; или null для применения нет.

dialogId: string

(Необязательно) Идентификатор созданного диалогового окна. Значение по умолчанию — QnAMakerDialog.

strictFiltersJoinOperator: JoinOperator

Оператор соединения для строгих фильтров

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Инициализирует новый экземпляр класса QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, activeLearningCardTitle?: string, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Параметры

knowledgeBaseId: string

Идентификатор базы знаний QnA Maker для запроса.

endpointKey: string

Ключ конечной точки QnA Maker, используемый для запроса базы знаний.

hostname: string

URL-адрес узла QnA Maker для базы знаний, начиная с "https://" и заканчивая "/qnamaker".

noAnswer: Activity

(Необязательно) Действие для отправки пользователя, когда QnA Maker не находит ответ.

threshold: number

activeLearningCardTitle: string

(Необязательно) Заголовок карточки, используемый при отображении параметров активного обучения пользователю, если включен активное обучение.

cardNoMatchText: string

top: number

(Необязательно) Максимальное количество ответов, возвращаемых из базы знаний.

cardNoMatchResponse: Activity

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

dialogId: string

(Необязательно) Идентификатор созданного диалогового окна. Значение по умолчанию — QnAMakerDialog.

strictFiltersJoinOperator: JoinOperator

Оператор соединения для строгих фильтров

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

Сведения о свойстве

$kind

static $kind: string

Значение свойства

string

activeLearningCardTitle

Получает или задает заголовок карточки, используемый при отображении параметров активного обучения пользователю. Примечание. Если предложениеActivityFactory передается, этот элемент не используется.

activeLearningCardTitle: StringExpression

Значение свойства

StringExpression

cardNoMatchResponse

Возвращает или задает шаблон для отправки пользователю, если он выбирает параметр соответствия на активной карточке обучения.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Возвращает или задает текст кнопки, используемый с активными параметрами обучения, что позволяет пользователю указывать, что параметры не применимы. Примечание. Если предложениеActivityFactory передается, этот элемент требуется.

cardNoMatchText: StringExpression

Значение свойства

StringExpression

displayPreciseAnswerOnly

Возвращает или задает значение, указывающее, должен ли ответ диалогового окна отображать только точные ответы.

displayPreciseAnswerOnly: boolean

Значение свойства

boolean

enablePreciseAnswer

Возвращает или задает значение, указывающее, следует ли включать точный ответ в ответ.

enablePreciseAnswer: boolean

Значение свойства

boolean

endpointKey

Возвращает или задает ключ конечной точки QnA Maker, используемый для запроса базы знаний.

endpointKey: StringExpression

Значение свойства

StringExpression

filters

Возвращает или задает метаданные и источники, используемые для фильтрации результатов.

filters: Filters

Значение свойства

Filters

hostname

Возвращает или задает URL-адрес узла QnA Maker для базы знаний.

hostname: StringExpression

Значение свойства

StringExpression

includeUnstructuredSources

Возвращает или задает значение, указывающее, следует ли включать неструктурированные источники в поиске ответов.

includeUnstructuredSources: boolean

Значение свойства

boolean

isTest

Возвращает или задает значение, указывающее, следует ли вызывать среду базы знаний или задать ее.

isTest: boolean

Значение свойства

boolean

knowledgeBaseId

Возвращает или задает идентификатор базы знаний QnA Maker для запроса.

knowledgeBaseId: StringExpression

Значение свойства

StringExpression

logPersonalInformation

Получает или задает флаг, чтобы определить, следует ли регистрировать персональные данные в телеметрии.

logPersonalInformation: BoolExpression

Значение свойства

BoolExpression

noAnswer

Получает или задает шаблон для отправки пользователю, когда QnA Maker не находит ответ.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

qnaServiceType

Тип службы ответов на вопросы — qnaMaker или язык

qnaServiceType: ServiceType

Значение свойства

ServiceType

rankerType

Возвращает или задает используемый тип ранжирования QnA Maker.

rankerType: EnumExpression<RankerTypes>

Значение свойства

EnumExpression<RankerTypes>

strictFilters

Возвращает или задает метаданные QnA Maker, с помощью которых можно фильтровать или повышать запросы к базе знаний, или значение NULL, чтобы применить его.

strictFilters: QnAMakerMetadata[]

Значение свойства

QnAMakerMetadata[]

strictFiltersJoinOperator

Возвращает или задает значение — И ИЛИ — логическая операция в списке метаданных

strictFiltersJoinOperator: JoinOperator

Значение свойства

JoinOperator

threshold

Возвращает или задает пороговое значение для возвращаемых ответов на основе оценки.

threshold: NumberExpression

Значение свойства

NumberExpression

top

Возвращает или задает максимальное количество ответов, возвращаемых из базы знаний.

top: IntExpression

Значение свойства

IntExpression

Сведения об унаследованном свойстве

EndOfTurn

Возвращает результат конца по умолчанию.

static EndOfTurn: DialogTurnResult

Значение свойства

DialogTurnResult

Этот результат указывает, что диалоговое окно (или логический шаг в диалоговом окне) завершило обработку текущего шага, по-прежнему активно и ожидает дополнительных входных данных.

унаследован от диалогового окна.EndOfTurn

id

id: string

Значение свойства

string

унаследован от Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Значение свойства

BotTelemetryClient

наследуется от Dialog.telemetryClient

Сведения о методе

beginDialog(DialogContext, object)

Вызывается при запуске диалогового окна и отправке в стек диалогов.

function beginDialog(dc: DialogContext, options?: object): Promise<DialogTurnResult>

Параметры

dc: DialogContext

DialogContext для текущей очереди беседы.

options: object

(Необязательно) Начальные сведения для передачи в диалоговое окно.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание разрешения результата поворота

continueDialog(DialogContext)

Вызывается, когда диалоговое окно продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Параметры

dc: DialogContext

DialogContext для текущей очереди беседы.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание, представляющее асинхронную операцию.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property: Object

Свойства, расширяющие QnAMakerDialogConfiguration.

Возвращаемое значение

Converter | ConverterFactory

Преобразователь выражений.

Сведения о наследуемом методе

addStep(WaterfallStep<O>)

Добавляет новый шаг в каскад.

function addStep(step: WaterfallStep<O>): this

Параметры

step: WaterfallStep<O>

Асинхронная функция шага для вызова.

Возвращаемое значение

this

Каскадное диалоговое окно для беглого вызова addStep().

Все функции шага должны быть асинхронными и возвращать DialogTurnResult. WaterfallStepContext, передаваемый в функцию, наследуется от DialogContext и содержит множество методов обработки стека, которые возвращают DialogTurnResult, поэтому обычно можно просто вернуть результат из вызываемого метода DialogContext.

Сама функция шага может быть асинхронным закрытием:

const helloDialog = new WaterfallDialog('hello');

helloDialog.addStep(async (step) => {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
});

Именованной асинхронной функции:

async function helloWorldStep(step) {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
}

helloDialog.addStep(helloWorldStep);

Или метод класса, привязанный к его this указателю:

helloDialog.addStep(this.helloWorldStep.bind(this));

унаследован от КаскаднойDialog.addStep

configure(Record<string, unknown>)

Метод Fluent для настройки объекта.

function configure(config: Record<string, unknown>): this

Параметры

config: Record<string, unknown>

Параметры конфигурации для применения.

Возвращаемое значение

this

После завершения операции настраиваемый.

наследуется от Configurable.configure

endDialog(TurnContext, DialogInstance, DialogReason)

Вызывается, когда диалоговое окно заканчивается.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Параметры

context: TurnContext

Контекст для текущей очереди беседы.

instance: DialogInstance

Экземпляр текущего диалогового окна.

reason: DialogReason

Причина окончания диалогового окна.

Возвращаемое значение

Promise<void>

унаследован от каскадного каскадного журнала.endDialog.endDialog

getVersion()

Возвращает версию диалогового окна, состоящую из идентификатора и количества шагов.

function getVersion(): string

Возвращаемое значение

string

Версия диалогового окна, состоящая из идентификатора и количества шагов.

наследуется от каскадного каскада.getDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Параметры

dc: DialogContext

Контекст диалогового окна для текущей очереди беседы.

e: DialogEvent

Возникает событие.

Возвращаемое значение

Promise<boolean>

Значение True, если событие обрабатывается текущим диалогом, а пузырьк должен остановиться.

унаследован от диалогового окна.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

При переопределении в производном классе переиздает пользователя для ввода.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Параметры

_context: TurnContext

Объект контекста для поворота.

_instance: DialogInstance

Текущие сведения о состоянии для этого диалогового окна.

Возвращаемое значение

Promise<void>

DialogContext вызывает этот метод, когда текущее диалоговое окно должно повторно запрашивать входные данные от пользователя. Этот метод реализуется для диалоговых окон запроса.

См. также

унаследован от диалогового окна "Диалоговое окно.repromptDialog"

resumeDialog(DialogContext, DialogReason, any)

Вызывается, когда дочерний Каскадныйdialog завершил свою очередь, возвращая элемент управления в этом диалоговом окне.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Параметры

dc: DialogContext

DialogContext для текущей очереди беседы.

reason: DialogReason

(xref:botbuilder-dialogs. DialogReason) почему диалоговое окно возобновляется.

result: any

Необязательное значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание, представляющее асинхронную операцию.

наследуется от КаскаднойDialog.resumeDialog

Поделиться через

QnAMakerDialog class

Конструкторы

Свойства

Унаследованные свойства

Методы

Наследуемые методы

Сведения о конструкторе

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Параметры

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Параметры

Сведения о свойстве

$kind

Значение свойства

activeLearningCardTitle

Значение свойства

cardNoMatchResponse

Значение свойства

cardNoMatchText

Значение свойства

displayPreciseAnswerOnly

Значение свойства

enablePreciseAnswer

Значение свойства

endpointKey

Значение свойства

filters

Значение свойства

hostname

Значение свойства

includeUnstructuredSources

Значение свойства

isTest

Значение свойства

knowledgeBaseId

Значение свойства

logPersonalInformation

Значение свойства

noAnswer

Значение свойства

qnaServiceType

Значение свойства

rankerType

Значение свойства

strictFilters

Значение свойства

strictFiltersJoinOperator

Значение свойства

threshold

Значение свойства

top

Значение свойства

Сведения об унаследованном свойстве

EndOfTurn

Значение свойства

Комментарии

id

Значение свойства

telemetryClient

Значение свойства

Сведения о методе

beginDialog(DialogContext, object)

Параметры

Возвращаемое значение

continueDialog(DialogContext)

Параметры

Возвращаемое значение

getConverter(Object)

Параметры

Возвращаемое значение

Сведения о наследуемом методе

addStep(WaterfallStep<O>)

Параметры

Возвращаемое значение

Комментарии

configure(Record<string, unknown>)

Параметры

Возвращаемое значение

endDialog(TurnContext, DialogInstance, DialogReason)