Class Suggestion.FaqAnswer.Builder (4.4.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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Suggestion.FaqAnswer build()
Returns
TypeDescription
Suggestion.FaqAnswer

buildPartial()

public Suggestion.FaqAnswer buildPartial()
Returns
TypeDescription
Suggestion.FaqAnswer

clear()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMetadata()

public Suggestion.FaqAnswer.Builder clearMetadata()
Returns
TypeDescription
Suggestion.FaqAnswer.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQuestion()

public Suggestion.FaqAnswer.Builder clearQuestion()

Output only. The corresponding FAQ question.

string question = 3;

Returns
TypeDescription
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
TypeDescription
Suggestion.FaqAnswer.Builder

This builder for chaining.

clone()

public Suggestion.FaqAnswer.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getAnswer()

public String getAnswer()

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

string answer = 1;

Returns
TypeDescription
String

The answer.

getAnswerBytes()

public ByteString getAnswerBytes()

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

string answer = 1;

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

The confidence.

getDefaultInstanceForType()

public Suggestion.FaqAnswer getDefaultInstanceForType()
Returns
TypeDescription
Suggestion.FaqAnswer

getDescriptor()

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

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

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

map<string, string> metadata = 5;

Returns
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getMutableMetadata()

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getQuestion()

public String getQuestion()

Output only. The corresponding FAQ question.

string question = 3;

Returns
TypeDescription
String

The question.

getQuestionBytes()

public ByteString getQuestionBytes()

Output only. The corresponding FAQ question.

string question = 3;

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

public Suggestion.FaqAnswer.Builder mergeFrom(Suggestion.FaqAnswer other)
Parameter
NameDescription
otherSuggestion.FaqAnswer
Returns
TypeDescription
Suggestion.FaqAnswer.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

The answer to set.

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

The bytes for answer to set.

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

The answerRecord to set.

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

The bytes for answerRecord to set.

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

The confidence to set.

Returns
TypeDescription
Suggestion.FaqAnswer.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setQuestion(String value)

public Suggestion.FaqAnswer.Builder setQuestion(String value)

Output only. The corresponding FAQ question.

string question = 3;

Parameter
NameDescription
valueString

The question to set.

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

The bytes for question to set.

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

The source to set.

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

The bytes for source to set.

Returns
TypeDescription
Suggestion.FaqAnswer.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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