Interface Suggestion.FaqAnswerOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Suggestion.FaqAnswer,Suggestion.FaqAnswer.Builder
- Enclosing class:
- Suggestion
public static interface Suggestion.FaqAnswerOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsMetadata(String key)Output only.StringgetAnswer()Output only.com.google.protobuf.ByteStringgetAnswerBytes()Output only.StringgetAnswerRecord()Output only.com.google.protobuf.ByteStringgetAnswerRecordBytes()Output only.floatgetConfidence()The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).Map<String,String>getMetadata()Deprecated.intgetMetadataCount()Output only.Map<String,String>getMetadataMap()Output only.StringgetMetadataOrDefault(String key, String defaultValue)Output only.StringgetMetadataOrThrow(String key)Output only.StringgetQuestion()Output only.com.google.protobuf.ByteStringgetQuestionBytes()Output only.StringgetSource()Output only.com.google.protobuf.ByteStringgetSourceBytes()Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getAnswer
String getAnswer()
Output only. The piece of text from the `source` knowledge base document.
string answer = 1;- Returns:
- The answer.
-
getAnswerBytes
com.google.protobuf.ByteString getAnswerBytes()
Output only. The piece of text from the `source` knowledge base document.
string answer = 1;- Returns:
- The bytes for answer.
-
getConfidence
float getConfidence()
The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).
float confidence = 2;- Returns:
- The confidence.
-
getQuestion
String getQuestion()
Output only. The corresponding FAQ question.
string question = 3;- Returns:
- The question.
-
getQuestionBytes
com.google.protobuf.ByteString getQuestionBytes()
Output only. The corresponding FAQ question.
string question = 3;- Returns:
- The bytes for question.
-
getSource
String getSource()
Output only. Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
string source = 4;- Returns:
- The source.
-
getSourceBytes
com.google.protobuf.ByteString getSourceBytes()
Output only. Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
string source = 4;- Returns:
- The bytes for source.
-
getMetadataCount
int getMetadataCount()
Output only. A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
-
containsMetadata
boolean containsMetadata(String key)
Output only. A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
-
getMetadata
@Deprecated Map<String,String> getMetadata()
Deprecated.UsegetMetadataMap()instead.
-
getMetadataMap
Map<String,String> getMetadataMap()
Output only. A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
-
getMetadataOrDefault
String getMetadataOrDefault(String key, String defaultValue)
Output only. A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
-
getMetadataOrThrow
String getMetadataOrThrow(String key)
Output only. A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
-
getAnswerRecord
String getAnswerRecord()
Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
string answer_record = 6;- Returns:
- The answerRecord.
-
getAnswerRecordBytes
com.google.protobuf.ByteString getAnswerRecordBytes()
Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
string answer_record = 6;- Returns:
- The bytes for answerRecord.
-
-