Package com.google.cloud.dialogflow.v2beta1

Class KnowledgeAnswers.Answer

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer
All Implemented Interfaces:
KnowledgeAnswers.AnswerOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
KnowledgeAnswers
public static final class KnowledgeAnswers.Answer extends com.google.protobuf.GeneratedMessage implements KnowledgeAnswers.AnswerOrBuilder
 An answer from Knowledge Connector.
Protobuf type google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KnowledgeAnswers.Answer.Builder
    An answer from Knowledge Connector.
    static enum 
    KnowledgeAnswers.Answer.MatchConfidenceLevel
    Represents the system's confidence that this knowledge answer is a good match for this conversational query.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ANSWER_FIELD_NUMBER
     
    static final int
    FAQ_QUESTION_FIELD_NUMBER
     
    static final int
    MATCH_CONFIDENCE_FIELD_NUMBER
     
    static final int
    MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER
     
    static final int
    SOURCE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAnswer()
    The piece of text from the `source` knowledge base document that answers this conversational query.
    com.google.protobuf.ByteString
    getAnswerBytes()
    The piece of text from the `source` knowledge base document that answers this conversational query.
    static KnowledgeAnswers.Answer
    getDefaultInstance()
     
    KnowledgeAnswers.Answer
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFaqQuestion()
    The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
    com.google.protobuf.ByteString
    getFaqQuestionBytes()
    The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.
    float
    getMatchConfidence()
    The system's confidence score that this Knowledge answer is a good match for this conversational query.
    KnowledgeAnswers.Answer.MatchConfidenceLevel
    getMatchConfidenceLevel()
    The system's confidence level that this knowledge answer is a good match for this conversational query.
    int
    getMatchConfidenceLevelValue()
    The system's confidence level that this knowledge answer is a good match for this conversational query.
    com.google.protobuf.Parser<KnowledgeAnswers.Answer>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getSource()
    Indicates which Knowledge Document this answer was extracted from.
    com.google.protobuf.ByteString
    getSourceBytes()
    Indicates which Knowledge Document this answer was extracted from.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KnowledgeAnswers.Answer.Builder
    newBuilder()
     
    static KnowledgeAnswers.Answer.Builder
    newBuilder(KnowledgeAnswers.Answer prototype)
     
    KnowledgeAnswers.Answer.Builder
    newBuilderForType()
     
    protected KnowledgeAnswers.Answer.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static KnowledgeAnswers.Answer
    parseDelimitedFrom(InputStream input)
     
    static KnowledgeAnswers.Answer
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnowledgeAnswers.Answer
    parseFrom(byte[] data)
     
    static KnowledgeAnswers.Answer
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnowledgeAnswers.Answer
    parseFrom(com.google.protobuf.ByteString data)
     
    static KnowledgeAnswers.Answer
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnowledgeAnswers.Answer
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KnowledgeAnswers.Answer
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnowledgeAnswers.Answer
    parseFrom(InputStream input)
     
    static KnowledgeAnswers.Answer
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KnowledgeAnswers.Answer
    parseFrom(ByteBuffer data)
     
    static KnowledgeAnswers.Answer
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KnowledgeAnswers.Answer>
    parser()
     
    KnowledgeAnswers.Answer.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • SOURCE_FIELD_NUMBER

      public static final int SOURCE_FIELD_NUMBER
      See Also:

    • FAQ_QUESTION_FIELD_NUMBER

      public static final int FAQ_QUESTION_FIELD_NUMBER
      See Also:

    • ANSWER_FIELD_NUMBER

      public static final int ANSWER_FIELD_NUMBER
      See Also:

    • MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER

      public static final int MATCH_CONFIDENCE_LEVEL_FIELD_NUMBER
      See Also:

    • MATCH_CONFIDENCE_FIELD_NUMBER

      public static final int MATCH_CONFIDENCE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static KnowledgeAnswers.Answer parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnowledgeAnswers.Answer parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KnowledgeAnswers.Answer parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnowledgeAnswers.Answer parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KnowledgeAnswers.Answer parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static KnowledgeAnswers.Answer.Builder newBuilder()

    • newBuilder

      public static KnowledgeAnswers.Answer.Builder newBuilder(KnowledgeAnswers.Answer prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static KnowledgeAnswers.Answer getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KnowledgeAnswers.Answer> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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