QnAMaker class

Pacote:

botbuilder-ai

Consulte uma base de dados de conhecimento do QnA Maker para obter respostas e fornecer comentários.

Construtores

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Cria uma nova instância do QnAMaker.

Propriedades

logPersonalInformation	Obtém um valor que indica se determina se as informações pessoais provenientes do usuário devem ser registradas.
telemetryClient	Obtém o BotTelemetryClient configurado no momento que registra os eventos.

Métodos

answer(TurnContext)	Chama generateAnswer() e envia a resposta resultante como uma resposta ao usuário.
callTrain(FeedbackRecords)	Envie comentários para o base de dados de conhecimento.
generateAnswer(string | undefined, number, number)	Chama o serviço QnA Maker para gerar respostas para uma pergunta.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Chama o serviço QnA Maker para gerar respostas para uma pergunta.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Gera uma resposta do base de dados de conhecimento.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Gera uma resposta da base de dados de conhecimento do QnA Maker.
getLowScoreVariation(QnAMakerResult[])	Filtra a pergunta ambígua para aprendizado ativo.

Detalhes do construtor

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Cria uma nova instância do QnAMaker.

new QnAMaker(endpoint: QnAMakerEndpoint, options?: QnAMakerOptions, telemetryClient?: BotTelemetryClient, logPersonalInformation?: boolean)

Parâmetros

endpoint

QnAMakerEndpoint

O ponto de extremidade do base de dados de conhecimento a ser consultado.

options

QnAMakerOptions

(Opcional) configurações adicionais usadas para configurar a instância.

telemetryClient

BotTelemetryClient

O BotTelemetryClient usado para registrar eventos de telemetria em log.

logPersonalInformation

boolean

Defina como true para incluir informações de identificação pessoal em eventos de telemetria.

Detalhes da propriedade

logPersonalInformation

Obtém um valor que indica se determina se as informações pessoais provenientes do usuário devem ser registradas.

boolean logPersonalInformation

Valor da propriedade

boolean

True se registrará informações pessoais no método BotTelemetryClient.TrackEvent; caso contrário, as propriedades serão filtradas.

telemetryClient

Obtém o BotTelemetryClient configurado no momento que registra os eventos.

BotTelemetryClient telemetryClient

Valor da propriedade

BotTelemetryClient

O BotTelemetryClient configurado no momento que registra o evento QnaMessage.

Detalhes do método

answer(TurnContext)

Aviso

Essa API foi preterida.

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

Chama generateAnswer() e envia a resposta resultante como uma resposta ao usuário.

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

Parâmetros

context

TurnContext

Contexto para a atual virada de conversa com o usuário.

Retornos

Promise<boolean>

Uma promessa de resolução para true se uma resposta foi enviada

callTrain(FeedbackRecords)

Envie comentários para o base de dados de conhecimento.

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

Parâmetros

feedbackRecords

FeedbackRecords

Registros de comentários.

Retornos

Promise<void>

Uma promessa que representa a operação assíncrona

generateAnswer(string | undefined, number, number)

Aviso

Essa API foi preterida.

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

Chama o serviço QnA Maker para gerar respostas para uma pergunta.

function generateAnswer(question: string | undefined, top?: number, _scoreThreshold?: number): Promise<QnAMakerResult[]>

Parâmetros

question

string | undefined

A pergunta a ser respondida.

top

number

(Opcional) número de respostas a serem retornadas. O padrão é um valor de 1.

_scoreThreshold

number

(Opcional) A pontuação mínima de resposta precisava ser considerada uma correspondência às perguntas. O padrão é um valor de 0.001.

Retornos

Promise<QnAMakerResult[]>

Uma promessa de resolução para os resultados do QnAMaker

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

Chama o serviço QnA Maker para gerar respostas para uma pergunta.

function getAnswers(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResult[]>

Parâmetros

context

TurnContext

O Contexto de Turno que contém a pergunta do usuário a ser consultada em relação ao seu base de dados de conhecimento.

options

QnAMakerOptions

(Opcional) As opções para o QnA Maker base de dados de conhecimento. Se for nulo, a opção de construtor será usada para essa instância.

telemetryProperties

[key: string]: string

Propriedades adicionais a serem registradas na telemetria com o evento QnaMessage.

telemetryMetrics

[key: string]: number

Métricas adicionais a serem registradas na telemetria com o evento QnaMessage.

Retornos

Promise<QnAMakerResult[]>

Uma promessa de resolução para o resultado do QnAMaker

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

Gera uma resposta do base de dados de conhecimento.

function getAnswersRaw(context: TurnContext, options: QnAMakerOptions, telemetryProperties: [key: string]: string, telemetryMetrics: [key: string]: number): Promise<QnAMakerResults>

Parâmetros

context

TurnContext

O TurnContext que contém a pergunta do usuário a ser consultada no base de dados de conhecimento.

options

QnAMakerOptions

Opcional. O QnAMakerOptions para o QnA Maker base de dados de conhecimento. Se for nulo, a opção de construtor será usada para essa instância.

telemetryProperties

[key: string]: string

Opcional. Propriedades adicionais a serem registradas na telemetria com o evento QnaMessage.

telemetryMetrics

[key: string]: number

Opcional. Métricas adicionais a serem registradas na telemetria com o evento QnaMessage.

Retornos

Promise<QnAMakerResults>

Uma lista de respostas para a consulta do usuário, classificada em ordem decrescente de pontuação de classificação.

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

Gera uma resposta da base de dados de conhecimento do QnA Maker.

function getLegacyAnswersRaw(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResults>

Parâmetros

context

TurnContext

O TurnContext que contém a pergunta do usuário a ser consultada no base de dados de conhecimento.

options

QnAMakerOptions

Opcional. O QnAMakerOptions para o QnA Maker base de dados de conhecimento. Se for nulo, a opção de construtor será usada para essa instância.

telemetryProperties

[key: string]: string

Opcional. Propriedades adicionais a serem registradas na telemetria com o evento QnaMessage.

telemetryMetrics

[key: string]: number

Opcional. Métricas adicionais a serem registradas na telemetria com o evento QnaMessage.

Retornos

Promise<QnAMakerResults>

Uma lista de respostas para a consulta do usuário, classificada em ordem decrescente de pontuação de classificação.

getLowScoreVariation(QnAMakerResult[])

Filtra a pergunta ambígua para aprendizado ativo.

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

Parâmetros

queryResult

QnAMakerResult[]

Saída da consulta do usuário.

Retornos

QnAMakerResult[]

os resultados filtrados