Class FaqAnswerData (2.47.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
Type Description
int

CONFIDENCE_SCORE_FIELD_NUMBER

public static final int CONFIDENCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

QUERY_RECORD_FIELD_NUMBER

public static final int QUERY_RECORD_FIELD_NUMBER
Field Value
Type Description
int

QUESTION_FIELD_NUMBER

public static final int QUESTION_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FaqAnswerData getDefaultInstance()
Returns
Type Description
FaqAnswerData

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FaqAnswerData.Builder newBuilder()
Returns
Type Description
FaqAnswerData.Builder

newBuilder(FaqAnswerData prototype)

public static FaqAnswerData.Builder newBuilder(FaqAnswerData prototype)
Parameter
Name Description
prototype FaqAnswerData
Returns
Type Description
FaqAnswerData.Builder

parseDelimitedFrom(InputStream input)

public static FaqAnswerData parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FaqAnswerData parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FaqAnswerData parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FaqAnswerData parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FaqAnswerData parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FaqAnswerData parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FaqAnswerData parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FaqAnswerData
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FaqAnswerData> parser()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnswer()

public String getAnswer()

The piece of text from the source knowledge base document.

string answer = 1;

Returns
Type Description
String

The answer.

getAnswerBytes()

public 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 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.

getDefaultInstanceForType()

public FaqAnswerData getDefaultInstanceForType()
Returns
Type Description
FaqAnswerData

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<FaqAnswerData> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for queryRecord.

getQuestion()

public String getQuestion()

The corresponding FAQ question.

string question = 3;

Returns
Type Description
String

The question.

getQuestionBytes()

public ByteString getQuestionBytes()

The corresponding FAQ question.

string question = 3;

Returns
Type Description
ByteString

The bytes for question.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for source.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FaqAnswerData.Builder newBuilderForType()
Returns
Type Description
FaqAnswerData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FaqAnswerData.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FaqAnswerData.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FaqAnswerData.Builder toBuilder()
Returns
Type Description
FaqAnswerData.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException