Class KnowledgeAnswers.Answer.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<KnowledgeAnswers.Answer.Builder>
com.google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer.Builder
All Implemented Interfaces:
KnowledgeAnswers.AnswerOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
KnowledgeAnswers.Answer

public static final class KnowledgeAnswers.Answer.Builder extends com.google.protobuf.GeneratedMessage.Builder<KnowledgeAnswers.Answer.Builder> implements KnowledgeAnswers.AnswerOrBuilder
 An answer from Knowledge Connector.
 
Protobuf type google.cloud.dialogflow.v2beta1.KnowledgeAnswers.Answer
  • 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.Builder<KnowledgeAnswers.Answer.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<KnowledgeAnswers.Answer.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<KnowledgeAnswers.Answer.Builder>
    • getDefaultInstanceForType

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

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

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

      public KnowledgeAnswers.Answer.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KnowledgeAnswers.Answer.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<KnowledgeAnswers.Answer.Builder>
    • mergeFrom

      public KnowledgeAnswers.Answer.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KnowledgeAnswers.Answer.Builder>
      Throws:
      IOException
    • 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.
    • setSource

      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) = { ... }
      Parameters:
      value - The source to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setSourceBytes

      public KnowledgeAnswers.Answer.Builder setSourceBytes(com.google.protobuf.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) = { ... }
      Parameters:
      value - The bytes for source to set.
      Returns:
      This builder for chaining.
    • 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.
    • setFaqQuestion

      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;
      Parameters:
      value - The faqQuestion to set.
      Returns:
      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:
      This builder for chaining.
    • setFaqQuestionBytes

      public KnowledgeAnswers.Answer.Builder setFaqQuestionBytes(com.google.protobuf.ByteString value)
       The corresponding FAQ question if the answer was extracted from a FAQ
       Document, empty otherwise.
       
      string faq_question = 2;
      Parameters:
      value - The bytes for faqQuestion to set.
      Returns:
      This builder for chaining.
    • 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.
    • setAnswer

      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;
      Parameters:
      value - The answer to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.
    • setAnswerBytes

      public KnowledgeAnswers.Answer.Builder setAnswerBytes(com.google.protobuf.ByteString value)
       The piece of text from the `source` knowledge base document that answers
       this conversational query.
       
      string answer = 3;
      Parameters:
      value - The bytes for answer to set.
      Returns:
      This builder for chaining.
    • 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.
    • setMatchConfidenceLevelValue

      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;
      Parameters:
      value - The enum numeric value on the wire for matchConfidenceLevel to set.
      Returns:
      This builder for chaining.
    • 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.
    • setMatchConfidenceLevel

       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;
      Parameters:
      value - The matchConfidenceLevel to set.
      Returns:
      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:
      This builder for chaining.
    • 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.
    • setMatchConfidence

      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;
      Parameters:
      value - The matchConfidence to set.
      Returns:
      This builder for chaining.
    • 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:
      This builder for chaining.