Class ArticleSuggestionData (2.4.0)

public final class ArticleSuggestionData extends GeneratedMessageV3 implements ArticleSuggestionDataOrBuilder

Agent Assist Article Suggestion data.

Protobuf type google.cloud.contactcenterinsights.v1.ArticleSuggestionData

Static Fields

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

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ArticleSuggestionData getDefaultInstance()
Returns
TypeDescription
ArticleSuggestionData

getDescriptor()

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

newBuilder()

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

newBuilder(ArticleSuggestionData prototype)

public static ArticleSuggestionData.Builder newBuilder(ArticleSuggestionData prototype)
Parameter
NameDescription
prototypeArticleSuggestionData
Returns
TypeDescription
ArticleSuggestionData.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

Map that contains metadata about the Article Suggestion 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

getConfidenceScore()

public float getConfidenceScore()

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

float confidence_score = 3;

Returns
TypeDescription
float

The confidenceScore.

getDefaultInstanceForType()

public ArticleSuggestionData getDefaultInstanceForType()
Returns
TypeDescription
ArticleSuggestionData

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Map that contains metadata about the Article Suggestion 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 Article Suggestion 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 Article Suggestion 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 Article Suggestion and the document that it originates from.

map<string, string> metadata = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<ArticleSuggestionData> getParserForType()
Returns
TypeDescription
Parser<ArticleSuggestionData>
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.

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.

getTitle()

public String getTitle()

Article title.

string title = 1;

Returns
TypeDescription
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Article title.

string title = 1;

Returns
TypeDescription
ByteString

The bytes for title.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUri()

public String getUri()

Article URI.

string uri = 2;

Returns
TypeDescription
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Article URI.

string uri = 2;

Returns
TypeDescription
ByteString

The bytes for uri.

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 ArticleSuggestionData.Builder newBuilderForType()
Returns
TypeDescription
ArticleSuggestionData.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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