QnAMaker class

패키지:

botbuilder-ai

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

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>

비동기 작업을 나타내는 약속

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[]

사용자 쿼리 출력.

반환

QnAMakerResult[]

필터링된 결과