Class FaqAnswerData.Builder (2.54.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public FaqAnswerData build()
Returns
Type Description
FaqAnswerData

buildPartial()

public FaqAnswerData buildPartial()
Returns
Type Description
FaqAnswerData

clear()

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

clearAnswer()

public FaqAnswerData.Builder clearAnswer()

The piece of text from the source knowledge base document.

string answer = 1;

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public FaqAnswerData.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
FaqAnswerData.Builder

This builder for chaining.

clearQuestion()

public FaqAnswerData.Builder clearQuestion()

The corresponding FAQ question.

string question = 3;

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

This builder for chaining.

clone()

public FaqAnswerData.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

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

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

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.

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.

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.

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FaqAnswerData.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
values Map<String,String>
Returns
Type Description
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
Name Description
key String
value String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Name Description
value String

The answer to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for answer to set.

Returns
Type Description
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
Name Description
value float

The confidenceScore to set.

Returns
Type Description
FaqAnswerData.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FaqAnswerData.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The queryRecord to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for queryRecord to set.

Returns
Type Description
FaqAnswerData.Builder

This builder for chaining.

setQuestion(String value)

public FaqAnswerData.Builder setQuestion(String value)

The corresponding FAQ question.

string question = 3;

Parameter
Name Description
value String

The question to set.

Returns
Type Description
FaqAnswerData.Builder

This builder for chaining.

setQuestionBytes(ByteString value)

public FaqAnswerData.Builder setQuestionBytes(ByteString value)

The corresponding FAQ question.

string question = 3;

Parameter
Name Description
value ByteString

The bytes for question to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value String

The source to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
FaqAnswerData.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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