public interface FaqAnswerOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMetadata(String key)
public abstract boolean containsMetadata(String key)A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnswer()
public abstract String getAnswer() The piece of text from the source knowledge base document.
string answer = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The answer. |
getAnswerBytes()
public abstract ByteString getAnswerBytes() The piece of text from the source knowledge base document.
string answer = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answer. |
getAnswerRecord()
public abstract String getAnswerRecord()The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
string answer_record = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The answerRecord. |
getAnswerRecordBytes()
public abstract ByteString getAnswerRecordBytes()The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
string answer_record = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answerRecord. |
getConfidence()
public abstract 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 | |
|---|---|
| Type | Description |
float |
The confidence. |
getMetadata() (deprecated)
public abstract Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public abstract int getMetadataCount()A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetadataMap()
public abstract Map<String,String> getMetadataMap()A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataOrDefault(String key, String defaultValue)
public abstract String getMetadataOrDefault(String key, String defaultValue)A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetadataOrThrow(String key)
public abstract String getMetadataOrThrow(String key)A map that contains metadata about the answer and the document from which it originates.
map<string, string> metadata = 5;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getQuestion()
public abstract String getQuestion()The corresponding FAQ question.
string question = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The question. |
getQuestionBytes()
public abstract ByteString getQuestionBytes()The corresponding FAQ question.
string question = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for question. |
getSource()
public abstract String getSource() 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 | |
|---|---|
| Type | Description |
String |
The source. |
getSourceBytes()
public abstract ByteString getSourceBytes() 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for source. |