Class ArticleSuggestionData.Builder (2.47.0)

public static final class ArticleSuggestionData.Builder extends GeneratedMessageV3.Builder<ArticleSuggestionData.Builder> implements ArticleSuggestionDataOrBuilder

Agent Assist Article Suggestion data.

Protobuf type google.cloud.contactcenterinsights.v1.ArticleSuggestionData

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ArticleSuggestionData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

build()

public ArticleSuggestionData build()
Returns
Type Description
ArticleSuggestionData

buildPartial()

public ArticleSuggestionData buildPartial()
Returns
Type Description
ArticleSuggestionData

clear()

public ArticleSuggestionData.Builder clear()
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

clearConfidenceScore()

public ArticleSuggestionData.Builder clearConfidenceScore()

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
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ArticleSuggestionData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

clearMetadata()

public ArticleSuggestionData.Builder clearMetadata()
Returns
Type Description
ArticleSuggestionData.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ArticleSuggestionData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

clearQueryRecord()

public ArticleSuggestionData.Builder clearQueryRecord()

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

string query_record = 5;

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

clearSource()

public ArticleSuggestionData.Builder clearSource()

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

string source = 6;

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

clearTitle()

public ArticleSuggestionData.Builder clearTitle()

Article title.

string title = 1;

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

clearUri()

public ArticleSuggestionData.Builder clearUri()

Article URI.

string uri = 2;

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

clone()

public ArticleSuggestionData.Builder clone()
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

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

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
Type Description
float

The confidenceScore.

getDefaultInstanceForType()

public ArticleSuggestionData getDefaultInstanceForType()
Returns
Type Description
ArticleSuggestionData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

map<string, string> metadata = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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.

getTitle()

public String getTitle()

Article title.

string title = 1;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Article title.

string title = 1;

Returns
Type Description
ByteString

The bytes for title.

getUri()

public String getUri()

Article URI.

string uri = 2;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Article URI.

string uri = 2;

Returns
Type Description
ByteString

The bytes for uri.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ArticleSuggestionData other)

public ArticleSuggestionData.Builder mergeFrom(ArticleSuggestionData other)
Parameter
Name Description
other ArticleSuggestionData
Returns
Type Description
ArticleSuggestionData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ArticleSuggestionData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ArticleSuggestionData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ArticleSuggestionData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ArticleSuggestionData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

putAllMetadata(Map<String,String> values)

public ArticleSuggestionData.Builder putAllMetadata(Map<String,String> values)

Map that contains metadata about the Article Suggestion and the document that it originates from.

map<string, string> metadata = 4;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ArticleSuggestionData.Builder

putMetadata(String key, String value)

public ArticleSuggestionData.Builder putMetadata(String key, String value)

Map that contains metadata about the Article Suggestion and the document that it originates from.

map<string, string> metadata = 4;

Parameters
Name Description
key String
value String
Returns
Type Description
ArticleSuggestionData.Builder

removeMetadata(String key)

public ArticleSuggestionData.Builder removeMetadata(String key)

Map that contains metadata about the Article Suggestion and the document that it originates from.

map<string, string> metadata = 4;

Parameter
Name Description
key String
Returns
Type Description
ArticleSuggestionData.Builder

setConfidenceScore(float value)

public ArticleSuggestionData.Builder setConfidenceScore(float value)

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;

Parameter
Name Description
value float

The confidenceScore to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ArticleSuggestionData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

setQueryRecord(String value)

public ArticleSuggestionData.Builder setQueryRecord(String value)

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

string query_record = 5;

Parameter
Name Description
value String

The queryRecord to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setQueryRecordBytes(ByteString value)

public ArticleSuggestionData.Builder setQueryRecordBytes(ByteString value)

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

string query_record = 5;

Parameter
Name Description
value ByteString

The bytes for queryRecord to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ArticleSuggestionData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

setSource(String value)

public ArticleSuggestionData.Builder setSource(String value)

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

string source = 6;

Parameter
Name Description
value String

The source to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public ArticleSuggestionData.Builder setSourceBytes(ByteString value)

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

string source = 6;

Parameter
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setTitle(String value)

public ArticleSuggestionData.Builder setTitle(String value)

Article title.

string title = 1;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public ArticleSuggestionData.Builder setTitleBytes(ByteString value)

Article title.

string title = 1;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ArticleSuggestionData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ArticleSuggestionData.Builder
Overrides

setUri(String value)

public ArticleSuggestionData.Builder setUri(String value)

Article URI.

string uri = 2;

Parameter
Name Description
value String

The uri to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.

setUriBytes(ByteString value)

public ArticleSuggestionData.Builder setUriBytes(ByteString value)

Article URI.

string uri = 2;

Parameter
Name Description
value ByteString

The bytes for uri to set.

Returns
Type Description
ArticleSuggestionData.Builder

This builder for chaining.