QnAMakerRecognizer class

Пакет:

botbuilder-ai

Распознаватель, использующий QnAMaker KB для распознавания намерений.

Extends

Recognizer

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

QnAMakerRecognizer(string, string, string)

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

Свойства

$kind
context	Выражение для вычисления контекста.
endpointKey	Ключ конечной точки для службы QnA.
hostname	Имя узла базы знаний QnA maker.
includeDialogNameInMetadata	Следует ли включать метаданные имени диалогового окна для контекста QnA.
isTest	Значение, указывающее, следует ли вызывать тестовую или продную среду базы знаний.
knowledgeBaseId	Идентификатор базы знаний базы знаний QnA maker.
logPersonalInformation	Флаг, указывающий, следует ли регистрировать персональные данные в телеметрии.
metadata	Выражение для оценки задания дополнительных пар значений имени метаданных.
qnaId	Выражение для оценки задания параметра QnAId.
qnaMatchIntent
rankerType	Desired RankerType.
strictFiltersJoinOperator	Значение, используемое для операции присоединения метаданных.
threshold	Пороговое значение для результатов.
top	Количество нужных результатов.

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

id	Уникальный идентификатор распознавателей.
telemetryClient	Клиент телеметрии для событий ведения журнала. По умолчанию используется nullTelemetryClient, который ничего не делает.

Методы

getConverter(Object)
recognize(DialogContext, Activity, [key: string]: string, [key: string]: number)	Возвращает результаты вызова qnA maker KB.

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

configure(Record<string, unknown>)

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

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

QnAMakerRecognizer(string, string, string)

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

new QnAMakerRecognizer(hostname?: string, knowledgeBaseId?: string, endpointKey?: string)

Параметры

hostname

string

Имя узла QnAMaker KB.

knowledgeBaseId

string

Идентификатор базы знаний QnAMaker.

endpointKey

string

Ключ конечной точки базы знаний QnAMaker.

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

$kind

static $kind: string

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

string

context

Выражение для вычисления контекста.

context: ObjectExpression<QnARequestContext>

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

ObjectExpression<QnARequestContext>

endpointKey

Ключ конечной точки для службы QnA.

endpointKey: StringExpression

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

StringExpression

hostname

Имя узла базы знаний QnA maker.

hostname: StringExpression

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

StringExpression

includeDialogNameInMetadata

Следует ли включать метаданные имени диалогового окна для контекста QnA.

includeDialogNameInMetadata: BoolExpression

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

BoolExpression

isTest

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

isTest: boolean

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

boolean

knowledgeBaseId

Идентификатор базы знаний базы знаний QnA maker.

knowledgeBaseId: StringExpression

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

StringExpression

logPersonalInformation

Флаг, указывающий, следует ли регистрировать персональные данные в телеметрии.

logPersonalInformation: BoolExpression

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

BoolExpression

metadata

Выражение для оценки задания дополнительных пар значений имени метаданных.

metadata: ArrayExpression<QnAMakerMetadata>

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

ArrayExpression<QnAMakerMetadata>

qnaId

Выражение для оценки задания параметра QnAId.

qnaId: IntExpression

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

IntExpression

qnaMatchIntent

static qnaMatchIntent: "QnAMatch" = "QnAMatch"

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

"QnAMatch"

rankerType

Desired RankerType.

rankerType: StringExpression

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

StringExpression

strictFiltersJoinOperator

Значение, используемое для операции присоединения метаданных.

strictFiltersJoinOperator: JoinOperator

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

JoinOperator

threshold

Пороговое значение для результатов.

threshold: NumberExpression

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

NumberExpression

top

Количество нужных результатов.

top: IntExpression

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

IntExpression

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

id

Уникальный идентификатор распознавателей.

id: string

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

string

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

telemetryClient

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

telemetryClient: BotTelemetryClient

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

BotTelemetryClient

Наследуется от Распознавателя.telemetryClient

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property

Object

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

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

Converter | ConverterFactory

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

recognize(DialogContext, Activity, [key: string]: string, [key: string]: number)

Возвращает результаты вызова qnA maker KB.

function recognize(dc: DialogContext, activity: Activity, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<RecognizerResult>

Параметры

dc

DialogContext

Объект Контекста, содержащий сведения для одного шага обложки с пользователем.

activity

Activity

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

telemetryProperties

[key: string]: string

Дополнительные свойства для записи в данные телеметрии.

telemetryMetrics

[key: string]: number

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

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

Promise<RecognizerResult>

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

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

configure(Record<string, unknown>)

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

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

Параметры

config

Record<string, unknown>

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

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

this

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

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