Class Suggestion.FaqAnswer.Builder (4.52.0)

public static final class Suggestion.FaqAnswer.Builder extends GeneratedMessageV3.Builder<Suggestion.FaqAnswer.Builder> implements Suggestion.FaqAnswerOrBuilder

Represents suggested answer from "frequently asked questions".

Protobuf type google.cloud.dialogflow.v2beta1.Suggestion.FaqAnswer

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Suggestion.FaqAnswer build()
Returns
Type Description
Suggestion.FaqAnswer

buildPartial()

public Suggestion.FaqAnswer buildPartial()
Returns
Type Description
Suggestion.FaqAnswer

clear()

public Suggestion.FaqAnswer.Builder clear()
Returns
Type Description
Suggestion.FaqAnswer.Builder
Overrides

clearAnswer()

public Suggestion.FaqAnswer.Builder clearAnswer()

Output only. The piece of text from the source knowledge base document.

string answer = 1;

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

clearAnswerRecord()

public Suggestion.FaqAnswer.Builder clearAnswerRecord()

Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"

string answer_record = 6;

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

clearConfidence()

public Suggestion.FaqAnswer.Builder clearConfidence()

The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

float confidence = 2;

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

public Suggestion.FaqAnswer.Builder clearMetadata()
Returns
Type Description
Suggestion.FaqAnswer.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQuestion()

public Suggestion.FaqAnswer.Builder clearQuestion()

Output only. The corresponding FAQ question.

string question = 3;

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

clearSource()

public Suggestion.FaqAnswer.Builder clearSource()

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 4;

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

clone()

public Suggestion.FaqAnswer.Builder clone()
Returns
Type Description
Suggestion.FaqAnswer.Builder
Overrides

containsMetadata(String key)

public boolean containsMetadata(String key)

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnswer()

public String getAnswer()

Output only. The piece of text from the source knowledge base document.

string answer = 1;

Returns
Type Description
String

The answer.

getAnswerBytes()

public ByteString getAnswerBytes()

Output only. The piece of text from the source knowledge base document.

string answer = 1;

Returns
Type Description
ByteString

The bytes for answer.

getAnswerRecord()

public String getAnswerRecord()

Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"

string answer_record = 6;

Returns
Type Description
String

The answerRecord.

getAnswerRecordBytes()

public ByteString getAnswerRecordBytes()

Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"

string answer_record = 6;

Returns
Type Description
ByteString

The bytes for answerRecord.

getConfidence()

public float getConfidence()

The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

float confidence = 2;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public Suggestion.FaqAnswer getDefaultInstanceForType()
Returns
Type Description
Suggestion.FaqAnswer

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

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Returns
Type Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

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>

getQuestion()

public String getQuestion()

Output only. The corresponding FAQ question.

string question = 3;

Returns
Type Description
String

The question.

getQuestionBytes()

public ByteString getQuestionBytes()

Output only. The corresponding FAQ question.

string question = 3;

Returns
Type Description
ByteString

The bytes for question.

getSource()

public String getSource()

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 4;

Returns
Type Description
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 4;

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(Suggestion.FaqAnswer other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllMetadata(Map<String,String> values)

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

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

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

putMetadata(String key, String value)

public Suggestion.FaqAnswer.Builder putMetadata(String key, String value)

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Parameters
Name Description
key String
value String
Returns
Type Description
Suggestion.FaqAnswer.Builder

removeMetadata(String key)

public Suggestion.FaqAnswer.Builder removeMetadata(String key)

Output only. A map that contains metadata about the answer and the document from which it originates.

map<string, string> metadata = 5;

Parameter
Name Description
key String
Returns
Type Description
Suggestion.FaqAnswer.Builder

setAnswer(String value)

public Suggestion.FaqAnswer.Builder setAnswer(String value)

Output only. 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
Suggestion.FaqAnswer.Builder

This builder for chaining.

setAnswerBytes(ByteString value)

public Suggestion.FaqAnswer.Builder setAnswerBytes(ByteString value)

Output only. 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
Suggestion.FaqAnswer.Builder

This builder for chaining.

setAnswerRecord(String value)

public Suggestion.FaqAnswer.Builder setAnswerRecord(String value)

Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"

string answer_record = 6;

Parameter
Name Description
value String

The answerRecord to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setAnswerRecordBytes(ByteString value)

public Suggestion.FaqAnswer.Builder setAnswerRecordBytes(ByteString value)

Output only. The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"

string answer_record = 6;

Parameter
Name Description
value ByteString

The bytes for answerRecord to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setConfidence(float value)

public Suggestion.FaqAnswer.Builder setConfidence(float value)

The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

float confidence = 2;

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setQuestion(String value)

public Suggestion.FaqAnswer.Builder setQuestion(String value)

Output only. The corresponding FAQ question.

string question = 3;

Parameter
Name Description
value String

The question to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setQuestionBytes(ByteString value)

public Suggestion.FaqAnswer.Builder setQuestionBytes(ByteString value)

Output only. The corresponding FAQ question.

string question = 3;

Parameter
Name Description
value ByteString

The bytes for question to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

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

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

setSource(String value)

public Suggestion.FaqAnswer.Builder setSource(String value)

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 4;

Parameter
Name Description
value String

The source to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public Suggestion.FaqAnswer.Builder setSourceBytes(ByteString value)

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

string source = 4;

Parameter
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
Suggestion.FaqAnswer.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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