Interface FaqAnswerDataOrBuilder (2.9.0)

Version 2.9.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.7

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

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.