Interface KnowledgeAnswers.AnswerOrBuilder (4.50.0)

public static interface KnowledgeAnswers.AnswerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswer()

public abstract String getAnswer()

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Returns
Type Description
String

The answer.

getAnswerBytes()

public abstract ByteString getAnswerBytes()

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Returns
Type Description
ByteString

The bytes for answer.

getFaqQuestion()

public abstract String getFaqQuestion()

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Returns
Type Description
String

The faqQuestion.

getFaqQuestionBytes()

public abstract ByteString getFaqQuestionBytes()

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Returns
Type Description
ByteString

The bytes for faqQuestion.

getMatchConfidence()

public abstract float getMatchConfidence()

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable.

float match_confidence = 5;

Returns
Type Description
float

The matchConfidence.

getMatchConfidenceLevel()

public abstract KnowledgeAnswers.Answer.MatchConfidenceLevel getMatchConfidenceLevel()

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Returns
Type Description
KnowledgeAnswers.Answer.MatchConfidenceLevel

The matchConfidenceLevel.

getMatchConfidenceLevelValue()

public abstract int getMatchConfidenceLevelValue()

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Returns
Type Description
int

The enum numeric value on the wire for matchConfidenceLevel.

getSource()

public abstract String getSource()

Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for source.