共用方式為


QnAMaker class

查詢 QnA Maker 知識庫以取得解答並提供意見反應。

建構函式

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

建立新的 QnAMaker 實例。

屬性

logPersonalInformation

取得值,指出是否判斷是否要記錄來自用戶的個人資訊。

telemetryClient

取得記錄事件的目前設定 BotTelemetryClient。

方法

answer(TurnContext)

呼叫 generateAnswer(),並以回復的形式傳送產生的回應給使用者。

callTrain(FeedbackRecords)

將意見反應傳送至知識庫。

generateAnswer(string | undefined, number, number)

呼叫 QnA Maker 服務來產生問題的解答。

getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

呼叫 QnA Maker 服務來產生問題的解答。

getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

從知識庫產生答案。

getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

從 QnA Maker 知識庫產生答案。

getLowScoreVariation(QnAMakerResult[])

篩選使用中學習的模棱兩可問題。

建構函式詳細資料

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 方法,則為 True;否則會篩選屬性。

telemetryClient

取得記錄事件的目前設定 BotTelemetryClient。

BotTelemetryClient telemetryClient

屬性值

BotTelemetryClient

目前設定的 BotTelemetryClient 會記錄 QnaMessage 事件。

方法詳細資料

answer(TurnContext)

警告

此 API 現已淘汰。

Instead, favor using QnAMaker.getAnswers() to generate answers for a question.

呼叫 generateAnswer(),並以回復的形式傳送產生的回應給使用者。

function answer(context: TurnContext): Promise<boolean>

參數

context

TurnContext

目前與使用者交談回合的內容。

傳回

Promise<boolean>

如果已傳送答案,則承諾會解決為 true

callTrain(FeedbackRecords)

將意見反應傳送至知識庫。

function callTrain(feedbackRecords: FeedbackRecords): Promise<void>

參數

feedbackRecords
FeedbackRecords

意見反應記錄。

傳回

Promise<void>

代表異步作業的承諾

generateAnswer(string | undefined, number, number)

警告

此 API 現已淘汰。

Instead, favor using QnAMaker.getAnswers() to generate answers for a question.

呼叫 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

QnAMakerResult[]

使用者查詢輸出。

傳回

篩選的結果