Interface FaqAnswerDataOrBuilder (2.51.0)

public interface FaqAnswerDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Map that contains metadata about the FAQ answer and the document that it originates from.

map<string, string> metadata = 4;

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.

getConfidenceScore()

public abstract float getConfidenceScore()

The system's confidence score that this answer is a good match for this conversation, ranging from 0.0 (completely uncertain) to 1.0 (completely certain).

float confidence_score = 2;

Returns
Type Description
float

The confidenceScore.

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

Map that contains metadata about the FAQ answer and the document that it originates from.

map<string, string> metadata = 4;

Returns
Type Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

Map that contains metadata about the FAQ answer and the document that it originates from.

map<string, string> metadata = 4;

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

Map that contains metadata about the FAQ answer and the document that it originates from.

map<string, string> metadata = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

Map that contains metadata about the FAQ answer and the document that it originates from.

map<string, string> metadata = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getQueryRecord()

public abstract String getQueryRecord()

The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

string query_record = 5;

Returns
Type Description
String

The queryRecord.

getQueryRecordBytes()

public abstract ByteString getQueryRecordBytes()

The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}

string query_record = 5;

Returns
Type Description
ByteString

The bytes for queryRecord.

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()

The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

string source = 6;

Returns
Type Description
String

The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

The knowledge document that this answer was extracted from. Format: projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.

string source = 6;

Returns
Type Description
ByteString

The bytes for source.