Class FaqAnswerData.Builder (2.18.0)

public static final class FaqAnswerData.Builder extends GeneratedMessageV3.Builder<FaqAnswerData.Builder> implements FaqAnswerDataOrBuilder

Agent Assist frequently-asked-question answer data.

Protobuf type google.cloud.contactcenterinsights.v1.FaqAnswerData

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FaqAnswerData build()
Returns
TypeDescription
FaqAnswerData

buildPartial()

public FaqAnswerData buildPartial()
Returns
TypeDescription
FaqAnswerData

clear()

public FaqAnswerData.Builder clear()
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

clearAnswer()

public FaqAnswerData.Builder clearAnswer()

The piece of text from the source knowledge base document.

string answer = 1;

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

clearConfidenceScore()

public FaqAnswerData.Builder clearConfidenceScore()

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
FaqAnswerData.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public FaqAnswerData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

clearQueryRecord()

public FaqAnswerData.Builder clearQueryRecord()

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

string query_record = 5;

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

clearQuestion()

public FaqAnswerData.Builder clearQuestion()

The corresponding FAQ question.

string question = 3;

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

clearSource()

public FaqAnswerData.Builder clearSource()

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

string source = 6;

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

clone()

public FaqAnswerData.Builder clone()
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

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

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

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

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.

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.

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.

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(FaqAnswerData other)

public FaqAnswerData.Builder mergeFrom(FaqAnswerData other)
Parameter
NameDescription
otherFaqAnswerData
Returns
TypeDescription
FaqAnswerData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FaqAnswerData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

putAllMetadata(Map<String,String> values)

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

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

map<string, string> metadata = 4;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
FaqAnswerData.Builder

putMetadata(String key, String value)

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

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

map<string, string> metadata = 4;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
FaqAnswerData.Builder

removeMetadata(String key)

public FaqAnswerData.Builder removeMetadata(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
FaqAnswerData.Builder

setAnswer(String value)

public FaqAnswerData.Builder setAnswer(String value)

The piece of text from the source knowledge base document.

string answer = 1;

Parameter
NameDescription
valueString

The answer to set.

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

setAnswerBytes(ByteString value)

public FaqAnswerData.Builder setAnswerBytes(ByteString value)

The piece of text from the source knowledge base document.

string answer = 1;

Parameter
NameDescription
valueByteString

The bytes for answer to set.

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

setConfidenceScore(float value)

public FaqAnswerData.Builder setConfidenceScore(float value)

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;

Parameter
NameDescription
valuefloat

The confidenceScore to set.

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setQueryRecord(String value)

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

This builder for chaining.

setQueryRecordBytes(ByteString value)

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

This builder for chaining.

setQuestion(String value)

public FaqAnswerData.Builder setQuestion(String value)

The corresponding FAQ question.

string question = 3;

Parameter
NameDescription
valueString

The question to set.

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

setQuestionBytes(ByteString value)

public FaqAnswerData.Builder setQuestionBytes(ByteString value)

The corresponding FAQ question.

string question = 3;

Parameter
NameDescription
valueByteString

The bytes for question to set.

Returns
TypeDescription
FaqAnswerData.Builder

This builder for chaining.

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

public FaqAnswerData.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
FaqAnswerData.Builder
Overrides

setSource(String value)

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

This builder for chaining.

setSourceBytes(ByteString value)

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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