Class ArticleSuggestionData.Builder (2.3.5) 

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ArticleSuggestionData.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ArticleSuggestionData.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ArticleSuggestionData.Builder
Overrides

build()

public ArticleSuggestionData build()
Returns
TypeDescription
ArticleSuggestionData

buildPartial()

public ArticleSuggestionData buildPartial()
Returns
TypeDescription
ArticleSuggestionData

clear()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ArticleSuggestionData.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ArticleSuggestionData.Builder
Overrides

clearMetadata()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public ArticleSuggestionData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

clearTitle()

public ArticleSuggestionData.Builder clearTitle()

Article title.

string title = 1;

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

clearUri()

public ArticleSuggestionData.Builder clearUri()

Article URI.

string uri = 2;

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

clone()

public ArticleSuggestionData.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
float

The confidenceScore.

getDefaultInstanceForType()

public ArticleSuggestionData getDefaultInstanceForType()
Returns
TypeDescription
ArticleSuggestionData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getMutableMetadata()

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
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.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ArticleSuggestionData other)

public ArticleSuggestionData.Builder mergeFrom(ArticleSuggestionData other)
Parameter
NameDescription
otherArticleSuggestionData
Returns
TypeDescription
ArticleSuggestionData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ArticleSuggestionData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ArticleSuggestionData.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ArticleSuggestionData.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ArticleSuggestionData.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ArticleSuggestionData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valuefloat

The confidenceScore to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ArticleSuggestionData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The queryRecord to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for queryRecord to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The source to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for source to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

setTitle(String value)

public ArticleSuggestionData.Builder setTitle(String value)

Article title.

string title = 1;

Parameter
NameDescription
valueString

The title to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public ArticleSuggestionData.Builder setTitleBytes(ByteString value)

Article title.

string title = 1;

Parameter
NameDescription
valueByteString

The bytes for title to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ArticleSuggestionData.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ArticleSuggestionData.Builder
Overrides

setUri(String value)

public ArticleSuggestionData.Builder setUri(String value)

Article URI.

string uri = 2;

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.

setUriBytes(ByteString value)

public ArticleSuggestionData.Builder setUriBytes(ByteString value)

Article URI.

string uri = 2;

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
ArticleSuggestionData.Builder

This builder for chaining.