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 知识库的知识库 ID。
logPersonalInformation	指示是否应在遥测中记录个人信息的标志。
metadata	要计算以设置其他元数据名称值对的表达式。
qnaId	要计算以设置 QnAId 参数的表达式。
qnaMatchIntent
rankerType	Desired RankerType。
strictFiltersJoinOperator	用于元数据的联接操作的值。
threshold	结果的阈值。
top	所需结果数。

继承属性

id	识别器唯一 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 KB 的 ID。

endpointKey

string

QnAMaker KB 的终结点密钥。

属性详细信息

$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 知识库的知识库 ID。

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。

id: string

属性值

string

继承自 Recognizer.id

telemetryClient

用于记录事件的遥测客户端。 默认为 NullTelemetryClient，后者不执行任何操作。

telemetryClient: BotTelemetryClient

属性值

BotTelemetryClient

继承自 Recognizer.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

操作完成后可配置的 。

继承自 Configure.configure