Interface KnowledgeAnswers.AnswerOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
KnowledgeAnswers.Answer
,KnowledgeAnswers.Answer.Builder
- Enclosing class:
- KnowledgeAnswers
public static interface KnowledgeAnswers.AnswerOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getAnswer()
The piece of text from the `source` knowledge base document that answers this conversational query.com.google.protobuf.ByteString
getAnswerBytes()
The piece of text from the `source` knowledge base document that answers this conversational query.String
getFaqQuestion()
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.com.google.protobuf.ByteString
getFaqQuestionBytes()
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.float
getMatchConfidence()
The system's confidence score that this Knowledge answer is a good match for this conversational query.KnowledgeAnswers.Answer.MatchConfidenceLevel
getMatchConfidenceLevel()
The system's confidence level that this knowledge answer is a good match for this conversational query.int
getMatchConfidenceLevelValue()
The system's confidence level that this knowledge answer is a good match for this conversational query.String
getSource()
Indicates which Knowledge Document this answer was extracted from.com.google.protobuf.ByteString
getSourceBytes()
Indicates which Knowledge Document this answer was extracted from.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getSource
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:
- The source.
-
getSourceBytes
com.google.protobuf.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:
- The bytes for source.
-
getFaqQuestion
String getFaqQuestion()
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
string faq_question = 2;
- Returns:
- The faqQuestion.
-
getFaqQuestionBytes
com.google.protobuf.ByteString getFaqQuestionBytes()
The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
string faq_question = 2;
- Returns:
- The bytes for faqQuestion.
-
getAnswer
String getAnswer()
The piece of text from the `source` knowledge base document that answers this conversational query.
string answer = 3;
- Returns:
- The answer.
-
getAnswerBytes
com.google.protobuf.ByteString getAnswerBytes()
The piece of text from the `source` knowledge base document that answers this conversational query.
string answer = 3;
- Returns:
- The bytes for answer.
-
getMatchConfidenceLevelValue
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:
- The enum numeric value on the wire for matchConfidenceLevel.
-
getMatchConfidenceLevel
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:
- The matchConfidenceLevel.
-
getMatchConfidence
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:
- The matchConfidence.
-
-