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

Настроенный в данный момент 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

Необязательный. QnAMakerOptions для базы знаний QnA Maker. Если значение 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

Необязательный. QnAMakerOptions для базы знаний QnA Maker. Если значение NULL, для этого экземпляра используется параметр конструктора.

telemetryProperties

[key: string]: string

Необязательный. Дополнительные свойства для записи в данные телеметрии с помощью события QnaMessage.

telemetryMetrics

[key: string]: number

Необязательный. Дополнительные метрики для записи в данные телеметрии с помощью события QnaMessage.

Возвращаемое значение

Promise<QnAMakerResults>

Список ответов на запрос пользователя, отсортированный в порядке уменьшения рейтинга.

getLowScoreVariation(QnAMakerResult[])

Фильтрует неоднозначный вопрос для активного обучения.

function getLowScoreVariation(queryResult: QnAMakerResult[]): QnAMakerResult[]

Параметры

queryResult

QnAMakerResult[]

Выходные данные запроса пользователя.

Возвращаемое значение

QnAMakerResult[]

отфильтрованные результаты