Class KnowledgeAnswers.Answer (4.3.1)

public static final class KnowledgeAnswers.Answer extends GeneratedMessageV3 implements KnowledgeAnswers.AnswerOrBuilder

An answer from Knowledge Connector.

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

Fields

ANSWER_FIELD_NUMBER

public static final int ANSWER_FIELD_NUMBER
Field Value
TypeDescription
int

FAQ_QUESTION_FIELD_NUMBER

public static final int FAQ_QUESTION_FIELD_NUMBER
Field Value
TypeDescription
int

MATCH_CONFIDENCE_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnswer()

public String getAnswer()

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

string answer = 3;

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

The bytes for answer.

getDefaultInstance()

public static KnowledgeAnswers.Answer getDefaultInstance()
Returns
TypeDescription
KnowledgeAnswers.Answer

getDefaultInstanceForType()

public KnowledgeAnswers.Answer getDefaultInstanceForType()
Returns
TypeDescription
KnowledgeAnswers.Answer

getDescriptor()

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

getFaqQuestion()

public String getFaqQuestion()

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

string faq_question = 2;

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

The enum numeric value on the wire for matchConfidenceLevel.

getParserForType()

public Parser<KnowledgeAnswers.Answer> getParserForType()
Returns
TypeDescription
Parser<Answer>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

The bytes for source.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static KnowledgeAnswers.Answer.Builder newBuilder()
Returns
TypeDescription
KnowledgeAnswers.Answer.Builder

newBuilder(KnowledgeAnswers.Answer prototype)

public static KnowledgeAnswers.Answer.Builder newBuilder(KnowledgeAnswers.Answer prototype)
Parameter
NameDescription
prototypeKnowledgeAnswers.Answer
Returns
TypeDescription
KnowledgeAnswers.Answer.Builder

newBuilderForType()

public KnowledgeAnswers.Answer.Builder newBuilderForType()
Returns
TypeDescription
KnowledgeAnswers.Answer.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeAnswers.Answer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KnowledgeAnswers.Answer.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static KnowledgeAnswers.Answer parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeAnswers.Answer parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeAnswers.Answer parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static KnowledgeAnswers.Answer parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static KnowledgeAnswers.Answer parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KnowledgeAnswers.Answer
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<KnowledgeAnswers.Answer> parser()
Returns
TypeDescription
Parser<Answer>

toBuilder()

public KnowledgeAnswers.Answer.Builder toBuilder()
Returns
TypeDescription
KnowledgeAnswers.Answer.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException