Package com.google.cloud.dialogflow.v2beta1

Class KnowledgeAnswers.Answer

    • Field Detail

      • FAQ_QUESTION_FIELD_NUMBER

        public static final int FAQ_QUESTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER

        public static final int MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MATCH_CONFIDENCE_FIELD_NUMBER

        public static final int MATCH_CONFIDENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getSource in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The source.

      • getSourceBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getSourceBytes in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The bytes for source.

      • getFaqQuestion

        public String getFaqQuestion()
         The corresponding FAQ question if the answer was extracted from a FAQ
 Document, empty otherwise.
        string faq_question = 2;
        Specified by:
        getFaqQuestion in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The faqQuestion.

      • getFaqQuestionBytes

        public com.google.protobuf.ByteString getFaqQuestionBytes()
         The corresponding FAQ question if the answer was extracted from a FAQ
 Document, empty otherwise.
        string faq_question = 2;
        Specified by:
        getFaqQuestionBytes in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The bytes for faqQuestion.

      • getAnswer

        public String getAnswer()
         The piece of text from the `source` knowledge base document that answers
 this conversational query.
        string answer = 3;
        Specified by:
        getAnswer in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The answer.

      • getAnswerBytes

        public com.google.protobuf.ByteString getAnswerBytes()
         The piece of text from the `source` knowledge base document that answers
 this conversational query.
        string answer = 3;
        Specified by:
        getAnswerBytes in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The bytes for answer.

      • 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;
        Specified by:
        getMatchConfidenceLevelValue in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The enum numeric value on the wire for matchConfidenceLevel.

      • 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;
        Specified by:
        getMatchConfidenceLevel in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The matchConfidenceLevel.

      • 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;
        Specified by:
        getMatchConfidence in interface KnowledgeAnswers.AnswerOrBuilder
        Returns:
        The matchConfidence.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KnowledgeAnswers.Answer parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public KnowledgeAnswers.Answer.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public KnowledgeAnswers.Answer.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected KnowledgeAnswers.Answer.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<KnowledgeAnswers.Answer> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public KnowledgeAnswers.Answer getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder