Class KnowledgeAnswers.Answer (4.13.0)

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

An answer from Knowledge Connector.

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

Static Fields

ANSWER_FIELD_NUMBER

public static final int ANSWER_FIELD_NUMBER
Field Value
Type Description
int

FAQ_QUESTION_FIELD_NUMBER

public static final int FAQ_QUESTION_FIELD_NUMBER
Field Value
Type Description
int

MATCH_CONFIDENCE_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER

public static final int MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KnowledgeAnswers.Answer getDefaultInstance()
Returns
Type Description
KnowledgeAnswers.Answer

getDescriptor()

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

newBuilder()

public static KnowledgeAnswers.Answer.Builder newBuilder()
Returns
Type Description
KnowledgeAnswers.Answer.Builder

newBuilder(KnowledgeAnswers.Answer prototype)

public static KnowledgeAnswers.Answer.Builder newBuilder(KnowledgeAnswers.Answer prototype)
Parameter
Name Description
prototype KnowledgeAnswers.Answer
Returns
Type Description
KnowledgeAnswers.Answer.Builder

parseDelimitedFrom(InputStream input)

public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KnowledgeAnswers.Answer parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KnowledgeAnswers.Answer parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KnowledgeAnswers.Answer parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KnowledgeAnswers.Answer parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KnowledgeAnswers.Answer parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KnowledgeAnswers.Answer parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KnowledgeAnswers.Answer
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KnowledgeAnswers.Answer.Builder newBuilderForType()
Returns
Type Description
KnowledgeAnswers.Answer.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KnowledgeAnswers.Answer.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KnowledgeAnswers.Answer.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KnowledgeAnswers.Answer.Builder toBuilder()
Returns
Type Description
KnowledgeAnswers.Answer.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException