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
True を指定すると、BotTelemetryClient.TrackEvent メソッドに個人情報が記録されます。それ以外の場合、プロパティはフィルター処理されます。
telemetryClient
イベントをログに記録する現在構成されている BotTelemetryClient を取得します。
BotTelemetryClient telemetryClientプロパティ値
BotTelemetryClient
QnaMessage イベントをログに記録する現在構成されている BotTelemetryClient。
メソッドの詳細
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>
非同期操作を表す promise
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
ユーザー クエリの出力。
戻り値
フィルター処理された結果