QnAMaker class

Paquete:

botbuilder-ai

Consulte una knowledge base de QnA Maker para obtener respuestas y proporcione comentarios.

Constructores

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crea una nueva instancia de QnAMaker.

Propiedades

logPersonalInformation	Obtiene un valor que indica si se debe registrar información personal procedente del usuario.
telemetryClient	Obtiene el botTelemetryClient configurado actualmente que registra los eventos.

Métodos

answer(TurnContext)	Llama a generateAnswer() y envía la respuesta resultante como respuesta al usuario.
callTrain(FeedbackRecords)	Envíe comentarios al knowledge base.
generateAnswer(string | undefined, number, number)	Llama al servicio QnA Maker para generar respuestas para una pregunta.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Llama al servicio QnA Maker para generar respuestas para una pregunta.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Genera una respuesta a partir del knowledge base.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Genera una respuesta del knowledge base de QnA Maker.
getLowScoreVariation(QnAMakerResult[])	Filtra la pregunta ambigua para el aprendizaje activo.

Detalles del constructor

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crea una nueva instancia de QnAMaker.

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

Parámetros

endpoint

QnAMakerEndpoint

Punto de conexión del knowledge base que se va a consultar.

options

QnAMakerOptions

(Opcional) opciones adicionales usadas para configurar la instancia.

telemetryClient

BotTelemetryClient

BotTelemetryClient se usa para registrar eventos de telemetría.

logPersonalInformation

boolean

Establézcalo en true para incluir información de identificación personal en eventos de telemetría.

Detalles de las propiedades

logPersonalInformation

Obtiene un valor que indica si se debe registrar información personal procedente del usuario.

boolean logPersonalInformation

Valor de propiedad

boolean

True si registrará información personal en el método BotTelemetryClient.TrackEvent; de lo contrario, se filtrarán las propiedades.

telemetryClient

Obtiene el botTelemetryClient configurado actualmente que registra los eventos.

BotTelemetryClient telemetryClient

Valor de propiedad

BotTelemetryClient

BotTelemetryClient configurado actualmente que registra el evento QnaMessage.

Detalles del método

answer(TurnContext)

Advertencia

Esta API ya está en desuso.

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

Llama a generateAnswer() y envía la respuesta resultante como respuesta al usuario.

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

Parámetros

context

TurnContext

Contexto para el turno actual de conversación con el usuario.

Devoluciones

Promise<boolean>

Una promesa que se resuelve en true si se envió una respuesta

callTrain(FeedbackRecords)

Envíe comentarios al knowledge base.

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

Parámetros

feedbackRecords

FeedbackRecords

Registros de comentarios.

Devoluciones

Promise<void>

Una promesa que representa la operación asincrónica

generateAnswer(string | undefined, number, number)

Advertencia

Esta API ya está en desuso.

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

Llama al servicio QnA Maker para generar respuestas para una pregunta.

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

Parámetros

question

string | undefined

La pregunta que se va a responder.

top

number

(Opcional) número de respuestas que se van a devolver. El valor 1predeterminado es .

_scoreThreshold

number

(Opcional) la puntuación mínima de respuesta necesaria para considerarse una coincidencia con las preguntas. El valor 0.001predeterminado es .

Devoluciones

Promise<QnAMakerResult[]>

Una promesa que se resuelve en los resultados de QnAMaker

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

Llama al servicio QnA Maker para generar respuestas para una pregunta.

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

Parámetros

context

TurnContext

Contexto de turno que contiene la pregunta del usuario que se va a consultar en la knowledge base.

options

QnAMakerOptions

(Opcional) Las opciones del knowledge base de QnA Maker. Si es null, se usa la opción de constructor para esta instancia.

telemetryProperties

[key: string]: string

Propiedades adicionales que se van a registrar en telemetría con el evento QnaMessage.

telemetryMetrics

[key: string]: number

Métricas adicionales que se registrarán en telemetría con el evento QnaMessage.

Devoluciones

Promise<QnAMakerResult[]>

Una promesa que se resuelve en el resultado de QnAMaker

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

Genera una respuesta a partir del knowledge base.

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

Parámetros

context

TurnContext

TurnContext que contiene la pregunta del usuario que se va a consultar en la knowledge base.

options

QnAMakerOptions

Opcional. QnAMakerOptions para el knowledge base de QnA Maker. Si es null, se usa la opción de constructor para esta instancia.

telemetryProperties

[key: string]: string

Opcional. Propiedades adicionales que se van a registrar en telemetría con el evento QnaMessage.

telemetryMetrics

[key: string]: number

Opcional. Métricas adicionales que se registrarán en telemetría con el evento QnaMessage.

Devoluciones

Promise<QnAMakerResults>

Una lista de respuestas para la consulta de usuario, ordenada en orden decreciente de la puntuación de clasificación.

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

Genera una respuesta del knowledge base de QnA Maker.

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

Parámetros

context

TurnContext

TurnContext que contiene la pregunta del usuario que se va a consultar en la knowledge base.

options

QnAMakerOptions

Opcional. QnAMakerOptions para el knowledge base de QnA Maker. Si es null, se usa la opción de constructor para esta instancia.

telemetryProperties

[key: string]: string

Opcional. Propiedades adicionales que se van a registrar en telemetría con el evento QnaMessage.

telemetryMetrics

[key: string]: number

Opcional. Métricas adicionales que se registrarán en telemetría con el evento QnaMessage.

Devoluciones

Promise<QnAMakerResults>

Una lista de respuestas para la consulta de usuario, ordenada en orden decreciente de la puntuación de clasificación.

getLowScoreVariation(QnAMakerResult[])

Filtra la pregunta ambigua para el aprendizaje activo.

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

Parámetros

queryResult

QnAMakerResult[]

Salida de la consulta de usuario.

Devoluciones

QnAMakerResult[]

los resultados filtrados