Interface FaqAnswerOrBuilder (4.53.0)

Version 4.53.0

• 4.58.0 (latest)
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface FaqAnswerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.