QnAMaker Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.ai.qna
Artefatto Maven:
com.microsoft.bot:bot-ai-qna:4.14.3
  • java.lang.Object
    • com.microsoft.bot.ai.qna.QnAMaker

Implementazioni

QnAMakerClient TelemetryQnAMaker

public class QnAMaker
implements QnAMakerClient, TelemetryQnAMaker

Fornisce l'accesso a una knowledge base di QnA Maker.

Riepilogo dei campi

Modificatore e tipo Campo e descrizione
static final java.lang.String QNA_MAKER_NAME

Nome della classe QnAMaker.
static final java.lang.String QNA_MAKER_TRACE_LABEL

Etichetta usata durante la registrazione della traccia di QnA Maker.
static final java.lang.String QNA_MAKER_TRACE_TYPE

Tipo utilizzato durante la registrazione della traccia di QnA Maker.

Riepilogo dei costruttori

Costruttore Descrizione
QnAMaker(QnAMakerEndpoint withEndpoint, QnAMakerOptions options)

Inizializza una nuova istanza della classe QnAMaker.
QnAMaker(QnAMakerEndpoint withEndpoint, QnAMakerOptions options, BotTelemetryClient withTelemetryClient, Boolean withLogPersonalInformation)

Inizializza una nuova istanza della classe QnAMaker.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
java.util.concurrent.CompletableFuture<java.lang.Void> callTrain(FeedbackRecords feedbackRecords)

Inviare commenti e suggerimenti alla Knowledge Base.
protected java.util.concurrent.CompletableFuture<Pair<java.util.Map<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,java.lang.Double>>> fillQnAEvent(QueryResult[] queryResults, TurnContext turnContext, Map<String,String> telemetryProperties, Map<String,Double> telemetryMetrics)

Riempie le proprietà e le metriche dell'evento QnaMessage per i dati di telemetria.
java.util.concurrent.CompletableFuture<QueryResult[]> getAnswers(TurnContext turnContext, QnAMakerOptions options)

Genera una risposta dalla Knowledge Base.
java.util.concurrent.CompletableFuture<QueryResult[]> getAnswers(TurnContext turnContext, QnAMakerOptions options, Map<String,String> telemetryProperties, Map<String,Double> telemetryMetrics)

Genera una risposta dalla Knowledge Base.
java.util.concurrent.CompletableFuture<QueryResults> getAnswersRaw(TurnContext turnContext, QnAMakerOptions options, Map<String,String> telemetryProperties, Map<String,Double> telemetryMetrics)

Genera una risposta dalla Knowledge Base.
java.lang.Boolean getLogPersonalInformation()

Ottiene un valore che indica se determinare se registrare informazioni personali provenienti dall'utente.
QueryResult[] getLowScoreVariation(QueryResult[] queryResult)

Filtra la domanda ambigua per l'apprendimento attivo.
BotTelemetryClient getTelemetryClient()

Ottiene il BotTelemetryClientattualmente configurato.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onQnaResults(QueryResult[] queryResults, TurnContext turnContext, Map<String,String> telemetryProperties, Map<String,Double> telemetryMetrics)

Eseguito quando viene restituito un risultato da QnA Maker.

Metodi ereditati da java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Dettagli del campo

QNA_MAKER_NAME

public static final String QNA_MAKER_NAME

Nome della classe QnAMaker.

QNA_MAKER_TRACE_LABEL

public static final String QNA_MAKER_TRACE_LABEL

Etichetta usata durante la registrazione della traccia di QnA Maker.

QNA_MAKER_TRACE_TYPE

public static final String QNA_MAKER_TRACE_TYPE

Tipo utilizzato durante la registrazione della traccia di QnA Maker.

Dettagli costruttore

QnAMaker

public QnAMaker(QnAMakerEndpoint withEndpoint, QnAMakerOptions options)

Inizializza una nuova istanza della classe QnAMaker.

Parametri:

withEndpoint - Endpoint della Knowledge Base su cui eseguire una query.
options - Opzioni per la knowledge base di QnA Maker.

QnAMaker

public QnAMaker(QnAMakerEndpoint withEndpoint, QnAMakerOptions options, BotTelemetryClient withTelemetryClient, Boolean withLogPersonalInformation)

Inizializza una nuova istanza della classe QnAMaker.

Parametri:

withEndpoint - Endpoint della Knowledge Base su cui eseguire una query.
options - Opzioni per la knowledge base di QnA Maker.
withTelemetryClient - IBotTelemetryClient usato per registrare gli eventi di telemetria.
withLogPersonalInformation - Impostare su true per includere informazioni personali negli eventi di telemetria.

Dettagli metodo

callTrain

public CompletableFuture callTrain(FeedbackRecords feedbackRecords)

Inviare commenti e suggerimenti alla Knowledge Base.

Parametri:

feedbackRecords - Record di feedback.

Restituisce:

Rappresentazione dell'operazione asincrona.

Genera un'eccezione:

java.io.IOException - Genera un'eccezione IOException se presente.

fillQnAEvent

protected CompletableFuture,Map>> fillQnAEvent(QueryResult[] queryResults, TurnContext turnContext, Map telemetryProperties, Map telemetryMetrics)

Riempie le proprietà e le metriche dell'evento QnaMessage per i dati di telemetria. Queste proprietà vengono registrate quando viene chiamato il metodo QnA GetAnswers.

Parametri:

queryResults - Risultati del servizio QnA.
turnContext - Oggetto contesto contenente informazioni per un singolo turno di conversazione con un utente.
telemetryProperties - Proprietà da aggiungere/eseguire l'override per l'evento.
telemetryMetrics - Metriche da aggiungere/sostituire per l'evento.

Restituisce:

Tupla di proprietà e metriche che verranno inviate a IBotTelemetryClient. Metodo TrackEvent per l'evento QnAMessage. Le proprietà e le metriche hanno restituito le proprietà standard registrate con le proprietà passate dal metodo GetAnswersAsync.

Genera un'eccezione:

java.io.IOException - Genera un'eccezione IOException se presente.

getAnswers

public CompletableFuture getAnswers(TurnContext turnContext, QnAMakerOptions options)

Genera una risposta dalla Knowledge Base.

Parametri:

turnContext - Contesto turn che contiene la domanda dell'utente su cui eseguire una query sulla knowledge base.
options - Opzioni per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.

Restituisce:

Elenco di risposte per la query dell'utente, ordinato in ordine decrescente del punteggio di classificazione.

getAnswers

public CompletableFuture getAnswers(TurnContext turnContext, QnAMakerOptions options, Map telemetryProperties, Map telemetryMetrics)

Genera una risposta dalla Knowledge Base.

Parametri:

turnContext - Contesto turn che contiene la domanda dell'utente su cui eseguire una query sulla knowledge base.
options - Opzioni per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.
telemetryProperties - Proprietà aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.
telemetryMetrics - Metriche aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

Restituisce:

Elenco di risposte per la query dell'utente, ordinato in ordine decrescente del punteggio di classificazione.

getAnswersRaw

public CompletableFuture getAnswersRaw(TurnContext turnContext, QnAMakerOptions options, Map telemetryProperties, Map telemetryMetrics)

Genera una risposta dalla Knowledge Base.

Parametri:

turnContext - Contesto turn che contiene la domanda dell'utente su cui eseguire una query sulla knowledge base.
options - Opzioni per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.
telemetryProperties - Proprietà aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.
telemetryMetrics - Metriche aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

Restituisce:

Elenco di risposte per la query dell'utente, ordinato in ordine decrescente del punteggio di classificazione.

getLogPersonalInformation

public Boolean getLogPersonalInformation()

Ottiene un valore che indica se determinare se registrare informazioni personali provenienti dall'utente.

Restituisce:

Se true, registra le informazioni personali nel metodo IBotTelemetryClient.TrackEvent; in caso contrario, le proprietà verranno filtrate.

getLowScoreVariation

public QueryResult[] getLowScoreVariation(QueryResult[] queryResult)

Filtra la domanda ambigua per l'apprendimento attivo.

Parametri:

queryResult - Output della query utente.

Restituisce:

Matrice filtrata di domanda ambigua.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Ottiene il BotTelemetryClientattualmente configurato.

Restituisce:

BotTelemetryClient in uso per registrare gli eventi.

onQnaResults

protected CompletableFuture onQnaResults(QueryResult[] queryResults, TurnContext turnContext, Map telemetryProperties, Map telemetryMetrics)

Eseguito quando viene restituito un risultato da QnA Maker.

Parametri:

queryResults - Matrice di QueryResult
turnContext - Il TurnContext
telemetryProperties - Proprietà aggiuntive da registrare ai dati di telemetria con l'evento LuisResult.
telemetryMetrics - Metriche aggiuntive da registrare ai dati di telemetria con l'evento LuisResult.

Restituisce:

Oggetto Task che rappresenta il lavoro da eseguire.

Genera un'eccezione:

java.io.IOException - Genera un'eccezione IOException se presente.

Si applica a