QnAMakerDialog class

Referência

Pacote:: botbuilder-ai

Uma caixa de diálogo que dá suporte a serviços do QnA Maker de várias etapas e de aprendizado adaptável.

Extends: WaterfallDialog

Construtores

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Inicializa uma nova instância da classe QnAMakerDialog.
QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Inicializa uma nova instância da classe QnAMakerDialog.

Propriedades

$kind
activeLearningCardTitle	Obtém ou define o título do cartão a ser usado ao mostrar opções de aprendizagem ativas para o usuário. Observação: se suggestionsActivityFactory for passado, esse membro não será utilizado.
cardNoMatchResponse	Obtém ou define o modelo a ser enviado ao usuário se ele selecionar a opção sem correspondência em um cartão de aprendizagem ativo.
cardNoMatchText	Obtém ou define o texto do botão a ser usado com opções de aprendizado ativo, permitindo que um usuário indique que não há opções aplicáveis. Observação: se suggestionsActivityFactory for passado, esse membro será necessário.
displayPreciseAnswerOnly	Obtém ou define um valor que indica se a resposta da caixa de diálogo deve exibir apenas respostas precisas.
enablePreciseAnswer	Obtém ou define um valor que indica se a resposta precisa deve ser incluída na resposta.
endpointKey	Obtém ou define a chave de ponto de extremidade do QnA Maker a ser usada para consultar a base de dados de conhecimento.
filters	Obtém ou define os metadados e as fontes usadas para filtrar os resultados.
hostname	Obtém ou define a URL de host do QnA Maker para a base de dados de conhecimento.
includeUnstructuredSources	Obtém ou define um valor que indica se as fontes não estruturadas devem ser incluídas na pesquisa de respostas.
isTest	Obtém ou define um valor que indica se obtém ou define o ambiente da base de dados de conhecimento a ser chamado.
knowledgeBaseId	Obtém ou define a ID da base de dados de conhecimento do QnA Maker para consulta.
logPersonalInformation	Obtém ou define o sinalizador para determinar se as informações pessoais devem ser registradas na telemetria.
noAnswer	Obtém ou define o modelo a ser enviado ao usuário quando o QnA Maker não encontrar uma resposta.
qnaServiceType	Tipo de serviço de resposta a perguntas – qnaMaker ou idioma
rankerType	Obtém ou define o tipo de classificador do QnA Maker a ser usado.
strictFilters	Obtém ou define os metadados do QnA Maker com os quais filtrar ou aumentar as consultas para a base de dados de conhecimento ou nulo para aplicar nenhuma.
strictFiltersJoinOperator	Obtém ou define um valor - AND ou OR - operação lógica na lista de metadados
threshold	Obtém ou define o limite de respostas retornadas, com base na pontuação.
top	Obtém ou define o número máximo de respostas a serem retornadas da base de dados de conhecimento.

Propriedades herdadas

EndOfTurn	Obtém um resultado de fim de turno padrão.
id
telemetryClient

Métodos

beginDialog(DialogContext, object)	Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.
continueDialog(DialogContext)	Chamado quando a caixa de diálogo é continuada, em que é a caixa de diálogo ativa e o usuário responde com um novo Activity.
getConverter(Object)

Métodos herdados

addStep(WaterfallStep<O>)	Adiciona uma nova etapa à cascata.
configure(Record<string, unknown>)	Método fluente para configurar o objeto.
endDialog(TurnContext, DialogInstance, DialogReason)	Chamado quando a caixa de diálogo está terminando.
getVersion()	Obtém a versão da caixa de diálogo, composta pela ID e número de etapas.
onDialogEvent(DialogContext, DialogEvent)	Chamado quando um evento foi gerado, usando `DialogContext.emitEvent()`, pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.
repromptDialog(TurnContext, DialogInstance)	Quando substituído em uma classe derivada, reprompta o usuário para entrada.
resumeDialog(DialogContext, DialogReason, any)	Chamado quando um filho WaterfallDialog completou sua vez, retornando o controle para essa caixa de diálogo.

Detalhes do construtor

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Inicializa uma nova instância da classe QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, suggestionsActivityFactory?: QnASuggestionsActivityFactory, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parâmetros

knowledgeBaseId: string

A ID da base de dados de conhecimento do QnA Maker a ser consultada.

endpointKey: string

A chave de ponto de extremidade do QnA Maker a ser usada para consultar a base de dados de conhecimento.

hostname: string

A URL de host do QnA Maker para a base de dados de conhecimento, começando com "https://" e terminando com "/qnamaker".

noAnswer: Activity

(Opcional) A atividade para enviar o usuário quando o QnA Maker não encontrar uma resposta.

threshold: number

(Opcional) O limite acima do qual tratar as respostas encontradas na base de dados de conhecimento como uma correspondência.

suggestionsActivityFactory: QnASuggestionsActivityFactory

(xref:botbuilder-ai. QnASuggestionsActivityFactory) usado para formatação de atividade personalizada.

cardNoMatchText: string

(Opcional) O texto do botão a ser usado com opções de aprendizado ativo, permitindo que um usuário indique que nenhuma das opções é aplicável.

top: number

(Opcional) Número máximo de respostas a serem retornadas da base de dados de conhecimento.

cardNoMatchResponse: Activity

(Opcional) A atividade para enviar o usuário se ele selecionar a opção sem correspondência em um cartão de aprendizagem ativo.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Opcional) Metadados do QnA Maker com os quais filtrar ou impulsionar consultas para a base de dados de conhecimento; ou nulo para aplicar nenhum.

dialogId: string

(Opcional) ID da caixa de diálogo criada. O padrão é 'QnAMakerDialog'.

strictFiltersJoinOperator: JoinOperator

operador de junção para filtros estritos

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Inicializa uma nova instância da classe QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, activeLearningCardTitle?: string, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parâmetros

knowledgeBaseId: string

A ID da base de dados de conhecimento do QnA Maker a ser consultada.

endpointKey: string

A chave de ponto de extremidade do QnA Maker a ser usada para consultar a base de dados de conhecimento.

hostname: string

A URL de host do QnA Maker para a base de dados de conhecimento, começando com "https://" e terminando com "/qnamaker".

noAnswer: Activity

(Opcional) A atividade para enviar o usuário quando o QnA Maker não encontrar uma resposta.

threshold: number

(Opcional) O limite acima do qual tratar as respostas encontradas na base de dados de conhecimento como uma correspondência.

activeLearningCardTitle: string

(Opcional) O título do cartão a ser usado ao mostrar opções de aprendizado ativo para o usuário, se o aprendizado ativo estiver habilitado.

cardNoMatchText: string

(Opcional) O texto do botão a ser usado com opções de aprendizado ativo, permitindo que um usuário indique que nenhuma das opções é aplicável.

top: number

(Opcional) Número máximo de respostas a serem retornadas da base de dados de conhecimento.

cardNoMatchResponse: Activity

(Opcional) A atividade para enviar o usuário se ele selecionar a opção sem correspondência em um cartão de aprendizagem ativo.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Opcional) Metadados do QnA Maker com os quais filtrar ou impulsionar consultas para a base de dados de conhecimento; ou nulo para aplicar nenhum.

dialogId: string

(Opcional) ID da caixa de diálogo criada. O padrão é 'QnAMakerDialog'.

strictFiltersJoinOperator: JoinOperator

operador de junção para filtros estritos

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

Detalhes da propriedade

$kind

static $kind: string

Valor da propriedade

string

activeLearningCardTitle

Obtém ou define o título do cartão a ser usado ao mostrar opções de aprendizagem ativas para o usuário. Observação: se suggestionsActivityFactory for passado, esse membro não será utilizado.

activeLearningCardTitle: StringExpression

Valor da propriedade

StringExpression

cardNoMatchResponse

Obtém ou define o modelo a ser enviado ao usuário se ele selecionar a opção sem correspondência em um cartão de aprendizagem ativo.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Obtém ou define o texto do botão a ser usado com opções de aprendizado ativo, permitindo que um usuário indique que não há opções aplicáveis. Observação: se suggestionsActivityFactory for passado, esse membro será necessário.

cardNoMatchText: StringExpression

Valor da propriedade

StringExpression

displayPreciseAnswerOnly

Obtém ou define um valor que indica se a resposta da caixa de diálogo deve exibir apenas respostas precisas.

displayPreciseAnswerOnly: boolean

Valor da propriedade

boolean

enablePreciseAnswer

Obtém ou define um valor que indica se a resposta precisa deve ser incluída na resposta.

enablePreciseAnswer: boolean

Valor da propriedade

boolean

endpointKey

Obtém ou define a chave de ponto de extremidade do QnA Maker a ser usada para consultar a base de dados de conhecimento.

endpointKey: StringExpression

Valor da propriedade

StringExpression

filters

Obtém ou define os metadados e as fontes usadas para filtrar os resultados.

filters: Filters

Valor da propriedade

Filters

hostname

Obtém ou define a URL de host do QnA Maker para a base de dados de conhecimento.

hostname: StringExpression

Valor da propriedade

StringExpression

includeUnstructuredSources

Obtém ou define um valor que indica se as fontes não estruturadas devem ser incluídas na pesquisa de respostas.

includeUnstructuredSources: boolean

Valor da propriedade

boolean

isTest

Obtém ou define um valor que indica se obtém ou define o ambiente da base de dados de conhecimento a ser chamado.

isTest: boolean

Valor da propriedade

boolean

knowledgeBaseId

Obtém ou define a ID da base de dados de conhecimento do QnA Maker para consulta.

knowledgeBaseId: StringExpression

Valor da propriedade

StringExpression

logPersonalInformation

Obtém ou define o sinalizador para determinar se as informações pessoais devem ser registradas na telemetria.

logPersonalInformation: BoolExpression

Valor da propriedade

BoolExpression

noAnswer

Obtém ou define o modelo a ser enviado ao usuário quando o QnA Maker não encontrar uma resposta.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Valor da propriedade

TemplateInterface<Partial<Activity>, DialogStateManager>

qnaServiceType

Tipo de serviço de resposta a perguntas – qnaMaker ou idioma

qnaServiceType: ServiceType

Valor da propriedade

ServiceType

rankerType

Obtém ou define o tipo de classificador do QnA Maker a ser usado.

rankerType: EnumExpression<RankerTypes>

Valor da propriedade

EnumExpression<RankerTypes>

strictFilters

Obtém ou define os metadados do QnA Maker com os quais filtrar ou aumentar as consultas para a base de dados de conhecimento ou nulo para aplicar nenhuma.

strictFilters: QnAMakerMetadata[]

Valor da propriedade

QnAMakerMetadata[]

strictFiltersJoinOperator

Obtém ou define um valor - AND ou OR - operação lógica na lista de metadados

strictFiltersJoinOperator: JoinOperator

Valor da propriedade

JoinOperator

threshold

Obtém ou define o limite de respostas retornadas, com base na pontuação.

threshold: NumberExpression

Valor da propriedade

NumberExpression

top

Obtém ou define o número máximo de respostas a serem retornadas da base de dados de conhecimento.

top: IntExpression

Valor da propriedade

IntExpression

Detalhes das propriedades herdadas

EndOfTurn

Obtém um resultado de fim de turno padrão.

static EndOfTurn: DialogTurnResult

Valor da propriedade

DialogTurnResult

Comentários

Esse resultado indica que uma caixa de diálogo (ou uma etapa lógica em uma caixa de diálogo) concluiu o processamento para a curva atual, ainda está ativa e está aguardando mais entrada.

herdado de dialog.EndOfTurn

id

id: string

Valor da propriedade

string

herdado de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valor da propriedade

BotTelemetryClient

Herdado de Dialog.telemetryClient

Detalhes do método

beginDialog(DialogContext, object)

Chamado quando a caixa de diálogo é iniciada e enviada por push para a pilha de diálogo.

function beginDialog(dc: DialogContext, options?: object): Promise<DialogTurnResult>

Parâmetros

dc: DialogContext

O dialogContext para a virada atual da conversa.

options: object

(Opcional) Informações iniciais a serem passadas para a caixa de diálogo.

Retornos

Promise<DialogTurnResult>

Uma promessa de resolução para o resultado da curva

continueDialog(DialogContext)

Chamado quando a caixa de diálogo é continuada, em que é a caixa de diálogo ativa e o usuário responde com um novo Activity.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parâmetros

dc: DialogContext

O dialogContext para a virada atual da conversa.

Retornos

Promise<DialogTurnResult>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parâmetros

property: Object

Propriedades que estendem QnAMakerDialogConfiguration.

Retornos

Converter | ConverterFactory

O conversor de expressão.

Detalhes do método herdado

addStep(WaterfallStep<O>)

Adiciona uma nova etapa à cascata.

function addStep(step: WaterfallStep<O>): this

Parâmetros

step: WaterfallStep<O>

Função de etapa assíncrona a ser chamada.

Retornos

this

Caixa de diálogo cascata para chamadas fluentes para addStep().

Comentários

Todas as funções de etapa devem ser assíncronas e retornar um DialogTurnResult. O WaterfallStepContext passado para sua função deriva de DialogContext e contém vários métodos de manipulação de pilha que retornam um DialogTurnResult para que você possa retornar o resultado do método DialogContext que você chama.

A função de etapa em si pode ser um fechamento assíncrono:

const helloDialog = new WaterfallDialog('hello');

helloDialog.addStep(async (step) => {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
});

Uma função assíncrona nomeada:

async function helloWorldStep(step) {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
}

helloDialog.addStep(helloWorldStep);

Ou um método de classe que foi associado ao seu ponteiro this:

helloDialog.addStep(this.helloWorldStep.bind(this));

Herdado de WaterfallDialog.addStep

configure(Record<string, unknown>)

Método fluente para configurar o objeto.

function configure(config: Record<string, unknown>): this

Parâmetros

config: Record<string, unknown>

Configurações a serem aplicadas.

Retornos

this

O configurável após a conclusão da operação.

Herdado de Configurble.configure

endDialog(TurnContext, DialogInstance, DialogReason)

Chamado quando a caixa de diálogo está terminando.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parâmetros

context: TurnContext

Contexto para a virada atual da conversa.

instance: DialogInstance

A instância da caixa de diálogo atual.

reason: DialogReason

O motivo pelo qual a caixa de diálogo está terminando.

Retornos

Promise<void>

herdado de WaterfallDialog.endDialog

getVersion()

Obtém a versão da caixa de diálogo, composta pela ID e número de etapas.

function getVersion(): string

Retornos

string

Versão da caixa de diálogo, composta pela ID e número de etapas.

herdado de WaterfallDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Chamado quando um evento foi gerado, usando DialogContext.emitEvent(), pela caixa de diálogo atual ou por uma caixa de diálogo iniciada pela caixa de diálogo atual.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parâmetros

dc: DialogContext

O contexto da caixa de diálogo para a virada atual da conversa.

e: DialogEvent

O evento que está sendo gerado.

Retornos

Promise<boolean>

True se o evento for tratado pela caixa de diálogo atual e o borbulhamento deve parar.

herdado da caixa de diálogo.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Quando substituído em uma classe derivada, reprompta o usuário para entrada.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parâmetros

_context: TurnContext

O objeto de contexto para a curva.

_instance: DialogInstance

Informações de estado atuais para essa caixa de diálogo.

Retornos

Promise<void>

Comentários

Caixas de diálogo derivadas que dão suporte à validação e à lógica de nova solicitação devem substituir esse método. Por padrão, esse método não tem efeito.

O DialogContext chama esse método quando a caixa de diálogo atual deve solicitar novamente a entrada do usuário. Esse método é implementado para caixas de diálogo de prompt.

Consulte também

Herdado de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Chamado quando um filho WaterfallDialog completou sua vez, retornando o controle para essa caixa de diálogo.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parâmetros

dc: DialogContext

O DialogContext para a virada atual da conversa.

reason: DialogReason

(xref:botbuilder-dialogs. DialogReason) por que a caixa de diálogo foi retomada.

result: any

Opcional, o valor retornado da caixa de diálogo que foi chamada. O tipo do valor retornado depende da caixa de diálogo filho.

Retornos

Promise<DialogTurnResult>

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

Herdado de WaterfallDialog.resumeDialog

Compartilhar via

QnAMakerDialog class

Construtores

Propriedades

Propriedades herdadas

Métodos

Métodos herdados

Detalhes do construtor

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Parâmetros

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Parâmetros

Detalhes da propriedade

$kind

Valor da propriedade

activeLearningCardTitle

Valor da propriedade

cardNoMatchResponse

Valor da propriedade

cardNoMatchText

Valor da propriedade

displayPreciseAnswerOnly

Valor da propriedade

enablePreciseAnswer

Valor da propriedade

endpointKey

Valor da propriedade

filters

Valor da propriedade

hostname

Valor da propriedade

includeUnstructuredSources

Valor da propriedade

isTest

Valor da propriedade

knowledgeBaseId

Valor da propriedade

logPersonalInformation

Valor da propriedade

noAnswer

Valor da propriedade

qnaServiceType

Valor da propriedade

rankerType

Valor da propriedade

strictFilters

Valor da propriedade

strictFiltersJoinOperator

Valor da propriedade

threshold

Valor da propriedade

top

Valor da propriedade

Detalhes das propriedades herdadas

EndOfTurn

Valor da propriedade

Comentários

id

Valor da propriedade

telemetryClient

Valor da propriedade

Detalhes do método

beginDialog(DialogContext, object)

Parâmetros

Retornos

continueDialog(DialogContext)

Parâmetros

Retornos

getConverter(Object)

Parâmetros

Retornos

Detalhes do método herdado

addStep(WaterfallStep<O>)

Parâmetros

Retornos

Comentários

configure(Record<string, unknown>)

Parâmetros

Retornos

endDialog(TurnContext, DialogInstance, DialogReason)