Class FaqAnswerData (2.16.0)

public final class FaqAnswerData extends GeneratedMessageV3 implements FaqAnswerDataOrBuilder

Agent Assist frequently-asked-question answer data.

Protobuf type google.cloud.contactcenterinsights.v1.FaqAnswerData

Static Fields

ANSWER_FIELD_NUMBER

public static final int ANSWER_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_SCORE_FIELD_NUMBER

public static final int CONFIDENCE_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_RECORD_FIELD_NUMBER

public static final int QUERY_RECORD_FIELD_NUMBER
Field Value
TypeDescription
int

QUESTION_FIELD_NUMBER

public static final int QUESTION_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FaqAnswerData getDefaultInstance()
Returns
TypeDescription
FaqAnswerData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FaqAnswerData.Builder newBuilder()
Returns
TypeDescription
FaqAnswerData.Builder

newBuilder(FaqAnswerData prototype)

public static FaqAnswerData.Builder newBuilder(FaqAnswerData prototype)
Parameter
NameDescription
prototypeFaqAnswerData
Returns
TypeDescription
FaqAnswerData.Builder

parseDelimitedFrom(InputStream input)

public static FaqAnswerData parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FaqAnswerData parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FaqAnswerData parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FaqAnswerData parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FaqAnswerData parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FaqAnswerData parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FaqAnswerData
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FaqAnswerData> parser()
Returns
TypeDescription
Parser<FaqAnswerData>

Methods

containsMetadata(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnswer()

public String getAnswer()

The piece of text from the source knowledge base document.

string answer = 1;

Returns
TypeDescription
String

The answer.

getAnswerBytes()

public ByteString getAnswerBytes()

The piece of text from the source knowledge base document.

string answer = 1;

Returns
TypeDescription
ByteString

The bytes for answer.

getConfidenceScore()

public 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
TypeDescription
float

The confidenceScore.

getDefaultInstanceForType()

public FaqAnswerData getDefaultInstanceForType()
Returns
TypeDescription
FaqAnswerData

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

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

map<string, string> metadata = 4;

Returns
TypeDescription
int

getMetadataMap()

public 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
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<FaqAnswerData> getParserForType()
Returns
TypeDescription
Parser<FaqAnswerData>
Overrides

getQueryRecord()

public String getQueryRecord()

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

string query_record = 5;

Returns
TypeDescription
String

The queryRecord.

getQueryRecordBytes()

public ByteString getQueryRecordBytes()

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

string query_record = 5;

Returns
TypeDescription
ByteString

The bytes for queryRecord.

getQuestion()

public String getQuestion()

The corresponding FAQ question.

string question = 3;

Returns
TypeDescription
String

The question.

getQuestionBytes()

public ByteString getQuestionBytes()

The corresponding FAQ question.

string question = 3;

Returns
TypeDescription
ByteString

The bytes for question.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSource()

public String getSource()

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

string source = 6;

Returns
TypeDescription
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

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

string source = 6;

Returns
TypeDescription
ByteString

The bytes for source.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FaqAnswerData.Builder newBuilderForType()
Returns
TypeDescription
FaqAnswerData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FaqAnswerData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FaqAnswerData.Builder toBuilder()
Returns
TypeDescription
FaqAnswerData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException