Class KnowledgeAnswers.Answer.Builder (4.42.0)

public static final class KnowledgeAnswers.Answer.Builder extends GeneratedMessageV3.Builder<KnowledgeAnswers.Answer.Builder> implements KnowledgeAnswers.AnswerOrBuilder

An answer from Knowledge Connector.

Protobuf type google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public KnowledgeAnswers.Answer build()
Returns
Type Description
KnowledgeAnswers.Answer

buildPartial()

public KnowledgeAnswers.Answer buildPartial()
Returns
Type Description
KnowledgeAnswers.Answer

clear()

public KnowledgeAnswers.Answer.Builder clear()
Returns
Type Description
KnowledgeAnswers.Answer.Builder
Overrides

clearAnswer()

public KnowledgeAnswers.Answer.Builder clearAnswer()

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

clearFaqQuestion()

public KnowledgeAnswers.Answer.Builder clearFaqQuestion()

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMatchConfidence()

public KnowledgeAnswers.Answer.Builder clearMatchConfidence()

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable.

float match_confidence = 5;

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

clearMatchConfidenceLevel()

public KnowledgeAnswers.Answer.Builder clearMatchConfidenceLevel()

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public KnowledgeAnswers.Answer.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
KnowledgeAnswers.Answer.Builder
Overrides

clearSource()

public KnowledgeAnswers.Answer.Builder clearSource()

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

string source = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

clone()

public KnowledgeAnswers.Answer.Builder clone()
Returns
Type Description
KnowledgeAnswers.Answer.Builder
Overrides

getAnswer()

public String getAnswer()

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Returns
Type Description
String

The answer.

getAnswerBytes()

public ByteString getAnswerBytes()

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Returns
Type Description
ByteString

The bytes for answer.

getDefaultInstanceForType()

public KnowledgeAnswers.Answer getDefaultInstanceForType()
Returns
Type Description
KnowledgeAnswers.Answer

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFaqQuestion()

public String getFaqQuestion()

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Returns
Type Description
String

The faqQuestion.

getFaqQuestionBytes()

public ByteString getFaqQuestionBytes()

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Returns
Type Description
ByteString

The bytes for faqQuestion.

getMatchConfidence()

public float getMatchConfidence()

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable.

float match_confidence = 5;

Returns
Type Description
float

The matchConfidence.

getMatchConfidenceLevel()

public KnowledgeAnswers.Answer.MatchConfidenceLevel getMatchConfidenceLevel()

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Returns
Type Description
KnowledgeAnswers.Answer.MatchConfidenceLevel

The matchConfidenceLevel.

getMatchConfidenceLevelValue()

public int getMatchConfidenceLevelValue()

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Returns
Type Description
int

The enum numeric value on the wire for matchConfidenceLevel.

getSource()

public String getSource()

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

string source = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

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

string source = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for source.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(KnowledgeAnswers.Answer other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KnowledgeAnswers.Answer.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KnowledgeAnswers.Answer.Builder
Overrides

setAnswer(String value)

public KnowledgeAnswers.Answer.Builder setAnswer(String value)

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Parameter
Name Description
value String

The answer to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setAnswerBytes(ByteString value)

public KnowledgeAnswers.Answer.Builder setAnswerBytes(ByteString value)

The piece of text from the source knowledge base document that answers this conversational query.

string answer = 3;

Parameter
Name Description
value ByteString

The bytes for answer to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setFaqQuestion(String value)

public KnowledgeAnswers.Answer.Builder setFaqQuestion(String value)

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Parameter
Name Description
value String

The faqQuestion to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setFaqQuestionBytes(ByteString value)

public KnowledgeAnswers.Answer.Builder setFaqQuestionBytes(ByteString value)

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

string faq_question = 2;

Parameter
Name Description
value ByteString

The bytes for faqQuestion to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMatchConfidence(float value)

public KnowledgeAnswers.Answer.Builder setMatchConfidence(float value)

The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using match_confidence_level which should be generally more stable.

float match_confidence = 5;

Parameter
Name Description
value float

The matchConfidence to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setMatchConfidenceLevel(KnowledgeAnswers.Answer.MatchConfidenceLevel value)

public KnowledgeAnswers.Answer.Builder setMatchConfidenceLevel(KnowledgeAnswers.Answer.MatchConfidenceLevel value)

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Parameter
Name Description
value KnowledgeAnswers.Answer.MatchConfidenceLevel

The matchConfidenceLevel to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setMatchConfidenceLevelValue(int value)

public KnowledgeAnswers.Answer.Builder setMatchConfidenceLevelValue(int value)

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.MatchConfidenceLevel match_confidence_level = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for matchConfidenceLevel to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

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

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

setSource(String value)

public KnowledgeAnswers.Answer.Builder setSource(String value)

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

string source = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The source to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setSourceBytes(ByteString value)

public KnowledgeAnswers.Answer.Builder setSourceBytes(ByteString value)

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

string source = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for source to set.

Returns
Type Description
KnowledgeAnswers.Answer.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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