QnAMaker class
查询 QnA Maker 知识库以获取答案并提供反馈。
构造函数
| Qn |
创建新的 QnAMaker 实例。 |
属性
| log |
获取一个值，该值指示是否确定是否记录来自用户的个人信息。 |
| telemetry |
获取记录事件的当前配置的 BotTelemetryClient。 |
方法
| answer(Turn |
调用 generateAnswer（），并将生成的答案作为答复发送给用户。 |
| call |
将反馈发送到知识库。 |
| generate |
调用 QnA Maker 服务以生成问题的答案。 |
| get |
调用 QnA Maker 服务以生成问题的答案。 |
| get |
从知识库生成答案。 |
| get |
从 QnA Maker 知识库生成答案。 |
| get |
筛选不明确的问题以主动学习。 |
构造函数详细信息
QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)
创建新的 QnAMaker 实例。
new QnAMaker(endpoint: QnAMakerEndpoint, options?: QnAMakerOptions, telemetryClient?: BotTelemetryClient, logPersonalInformation?: boolean)参数
- endpoint
- QnAMakerEndpoint
要查询的知识库的终结点。
- options
- QnAMakerOptions
（可选）用于配置实例的其他设置。
- telemetryClient
-
BotTelemetryClient
用于记录遥测事件的 BotTelemetryClient。
- logPersonalInformation
-
boolean
设置为 true 以在遥测事件中包含个人身份信息。
属性详细信息
logPersonalInformation
获取一个值，该值指示是否确定是否记录来自用户的个人信息。
boolean logPersonalInformation属性值
boolean
如此 如果将个人信息记录到 BotTelemetryClient.TrackEvent 方法中;否则，将筛选属性。
telemetryClient
获取记录事件的当前配置的 BotTelemetryClient。
BotTelemetryClient telemetryClient属性值
BotTelemetryClient
当前配置的 BotTelemetryClient 用于记录 QnaMessage 事件。
方法详细信息
answer(TurnContext)
调用 generateAnswer（），并将生成的答案作为答复发送给用户。
function answer(context: TurnContext): Promise<boolean>参数
- context
-
TurnContext
与用户的当前会话轮次的上下文。
返回
Promise<boolean>
如果发送了答案，则承诺会解析为 true
callTrain(FeedbackRecords)
将反馈发送到知识库。
function callTrain(feedbackRecords: FeedbackRecords): Promise<void>参数
- feedbackRecords
- FeedbackRecords
反馈记录。
返回
Promise<void>
表示异步操作的 promise
generateAnswer(string | undefined, number, number)
调用 QnA Maker 服务以生成问题的答案。
function generateAnswer(question: string | undefined, top?: number, _scoreThreshold?: number): Promise<QnAMakerResult[]>参数
- question
-
string | undefined
要回答的问题。
- top
-
number
（可选） 要返回的答案数。 默认值为 1。
- _scoreThreshold
-
number
（可选）需要将最低答案分数视为与问题匹配。 默认值为 0.001。
返回
Promise<QnAMakerResult[]>
解决 QnAMaker 结果的承诺
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)
调用 QnA Maker 服务以生成问题的答案。
function getAnswers(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResult[]>参数
- context
-
TurnContext
包含要针对知识库查询的用户问题的轮次上下文。
- options
- QnAMakerOptions
（可选）QnA Maker 知识库的选项。 如果为 null，则此实例使用构造函数选项。
- telemetryProperties
-
[key: string]: string
要通过 QnaMessage 事件记录到遥测的其他属性。
- telemetryMetrics
-
[key: string]: number
使用 QnaMessage 事件记录到遥测的其他指标。
返回
Promise<QnAMakerResult[]>
解析为 QnAMaker 结果的承诺
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)
从知识库生成答案。
function getAnswersRaw(context: TurnContext, options: QnAMakerOptions, telemetryProperties: [key: string]: string, telemetryMetrics: [key: string]: number): Promise<QnAMakerResults>参数
- context
-
TurnContext
包含针对知识库查询的用户问题的 TurnContext。
- options
- QnAMakerOptions
自选。 QnA Maker 知识库的 QnAMakerOptions。 如果为 null，则此实例使用构造函数选项。
- telemetryProperties
-
[key: string]: string
自选。 要通过 QnaMessage 事件记录到遥测的其他属性。
- telemetryMetrics
-
[key: string]: number
自选。 使用 QnaMessage 事件记录到遥测的其他指标。
返回
Promise<QnAMakerResults>
用户查询的答案列表，按排名分数的递减顺序排序。
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)
从 QnA Maker 知识库生成答案。
function getLegacyAnswersRaw(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResults>参数
- context
-
TurnContext
包含针对知识库查询的用户问题的 TurnContext。
- options
- QnAMakerOptions
自选。 QnA Maker 知识库的 QnAMakerOptions。 如果为 null，则此实例使用构造函数选项。
- telemetryProperties
-
[key: string]: string
自选。 要通过 QnaMessage 事件记录到遥测的其他属性。
- telemetryMetrics
-
[key: string]: number
自选。 使用 QnaMessage 事件记录到遥测的其他指标。
返回
Promise<QnAMakerResults>
用户查询的答案列表，按排名分数的递减顺序排序。
getLowScoreVariation(QnAMakerResult[])
筛选不明确的问题以主动学习。
function getLowScoreVariation(queryResult: QnAMakerResult[]): QnAMakerResult[]参数
- queryResult
用户查询输出。
返回
筛选的结果